NSX-T Data Center REST API

Methods:

API Description API Path
Cloud Service Manager > AWS Accounts
Return a list of all AWS accounts
GET /api/v1/csm/aws/accounts
Cloud Service Manager > AWS Accounts
Add a AWS account to cloud serivce manager
POST /api/v1/csm/aws/accounts
Cloud Service Manager > AWS Accounts
Delete AWS account information
DELETE /api/v1/csm/aws/accounts/<account-id>
Cloud Service Manager > AWS Accounts
Returns the details of the particular AWS account
GET /api/v1/csm/aws/accounts/<account-id>
Cloud Service Manager > AWS Accounts
Synchronizes Aws account related inventory like Regions, Vpcs, Instances Status of inventory synchronization can be known from Aws account status api
POST /api/v1/csm/aws/accounts/<account-id>?action=sync_inventory
Cloud Service Manager > AWS Accounts
Update a AWS account information
PUT /api/v1/csm/aws/accounts/<account-id>
Cloud Service Manager > AWS Accounts
Returns a list of desired regions for a particular AWS account
GET /api/v1/csm/aws/accounts/<account-id>/desired-regions
Cloud Service Manager > AWS Accounts
Updates the list of desired regions for a particular AWS account
PUT /api/v1/csm/aws/accounts/<account-id>/desired-regions
Cloud Service Manager > AWS Accounts
Return status of the account like credentials validity, inventory synchronization status and inventory synchronization state
GET /api/v1/csm/aws/accounts/<account-id>/status
Cloud Service Manager > AWS Gateway AMIS
DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Returns a list of Aws Gateway Amis.
GET /api/v1/csm/aws/gateway-amis (Deprecated)
Cloud Service Manager > AWS Gateway AMIS
DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Registers a AWS Gateway AMI for the region specified in the body. One can register only one gateway AMI ID per region. If a gateway AMI is already registered with a region, user is expected to use update API to overwrite the registerd AMI for a region.
POST /api/v1/csm/aws/gateway-amis (Deprecated)
Cloud Service Manager > AWS Gateway AMIS
DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Delete a AWS Gateway AMI.
DELETE /api/v1/csm/aws/gateway-amis/<region-id> (Deprecated)
Cloud Service Manager > AWS Gateway AMIS
DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Returns AWS Gateway AMI for a particular region.
GET /api/v1/csm/aws/gateway-amis/<region-id> (Deprecated)
Cloud Service Manager > AWS Gateway AMIS
DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Update a AWS Gateway AMI.
PUT /api/v1/csm/aws/gateway-amis/<region-id> (Deprecated)
Cloud Service Manager > AWS Gateways
Returns configuration information for all gateways
GET /api/v1/csm/aws/gateways
Cloud Service Manager > AWS Gateways
Deploys gateway for the specified VPC
POST /api/v1/csm/aws/gateways?action=deploy
Cloud Service Manager > AWS Gateways
Undeploys gateway for the specified VPC
POST /api/v1/csm/aws/gateways?action=undeploy
Cloud Service Manager > AWS Gateways
Returns configuration for primary gateway and secondary gateway for the vpc,if exists.
GET /api/v1/csm/aws/gateways/<vpc-id>
Cloud Service Manager > AWS Gateways
Updates configuration for primary gateway and secondary gateway for the vpc, if exists.
PUT /api/v1/csm/aws/gateways/<vpc-id>
Cloud Service Manager > AWS Gateways
Returns status information for primary gateway and secondary gateway for the vpc, if exists.
GET /api/v1/csm/aws/gateways/<vpc-id>/status
Cloud Service Manager > AWS Key Pairs
Returns a list of Aws Key Pairs
GET /api/v1/csm/aws/key-pairs
Cloud Service Manager > AWS Key Pairs
Returns a list of subnets
GET /api/v1/csm/aws/subnets
Cloud Service Manager > AWS Regions
Returns a list of Aws regions
GET /api/v1/csm/aws/regions
Cloud Service Manager > AWS Regions
Returns information about the particular Aws Region
GET /api/v1/csm/aws/regions/<region-id>
Cloud Service Manager > AWS Resources
Returns a list of AWS public IPs
GET /api/v1/csm/aws/public-ips
Cloud Service Manager > AWS Resources
Returns a list of AWS security groups. Deprecated: Please use /csm/aws/vpcs/<vpc-id>/security-groups instead.
GET /api/v1/csm/aws/vpcs/security-groups (Deprecated)
Cloud Service Manager > AWS VPCS
Returns the list of configuration of the compute VPC. The configuration contains quarantine policy and fall back security group of compute VPC and the information related to transit VPC.
GET /api/v1/csm/aws/compute-vpcs
Cloud Service Manager > AWS VPCS
Offboards a compute VPC.
DELETE /api/v1/csm/aws/compute-vpcs/<vpc-id>
Cloud Service Manager > AWS VPCS
Returns the configuration of the compute VPC. The configuration contains quarantine policy and fall back security group of compute VPC and the information related to transit VPC.
GET /api/v1/csm/aws/compute-vpcs/<vpc-id>
Cloud Service Manager > AWS VPCS
Onboards a compute VPC to be NSX managed by a transit VPC.
POST /api/v1/csm/aws/compute-vpcs/<vpc-id>
Cloud Service Manager > AWS VPCS
Updates the NSX configuration related to managed compute VPC using a transit VPC.
PUT /api/v1/csm/aws/compute-vpcs/<vpc-id>
Cloud Service Manager > AWS VPCS
Returns the status of the compute vpc. The status corresponds to onboard or offboard status of a compute VPC.
GET /api/v1/csm/aws/compute-vpcs/<vpc-id>/status
Cloud Service Manager > AWS VPCS
Returns a list of Vpcs. Support optional query parameters like account_id, region_id, cidr and/or op_status
GET /api/v1/csm/aws/vpcs
Cloud Service Manager > AWS VPCS
Returns Vpc information
GET /api/v1/csm/aws/vpcs/<vpc-id>
Cloud Service Manager > AWS > VPCS > Security Groups
Returns a list of AWS security groups corresponding to a VPC
GET /api/v1/csm/aws/vpcs/<vpc-id>/security-groups
Cloud Service Manager > AWS > VPCS > Security Groups
Returns information about a particular AWS security group
GET /api/v1/csm/aws/vpcs/<vpc-id>/security-groups/<security-group-id>
Cloud Service Manager > AWS > VPCS > Service Endpoints
Returns list of AWS serivce endpoints corresponding to a VPC
GET /api/v1/csm/aws/vpcs/<vpc-id>/service-endpoints
Cloud Service Manager > AWS > VPCS > Service Endpoints
Returns information about a particular AWS serivce endpoint
GET /api/v1/csm/aws/vpcs/<vpc-id>/service-endpoints/<service-endpoint-id>
Cloud Service Manager > Accounts Statistics
Returns statistics for all Accounts
GET /api/v1/csm/accounts/statistics
Cloud Service Manager > Azure Accounts
Returns a list of Azure accounts
GET /api/v1/csm/azure/accounts
Cloud Service Manager > Azure Accounts
Add a Azure account to cloud serivce manager
POST /api/v1/csm/azure/accounts
Cloud Service Manager > Azure Accounts
Delete Azure account information
DELETE /api/v1/csm/azure/accounts/<account-id>
Cloud Service Manager > Azure Accounts
Returns information about a particular Azure account
GET /api/v1/csm/azure/accounts/<account-id>
Cloud Service Manager > Azure Accounts
Synchronizes Azure account inventory
POST /api/v1/csm/azure/accounts/<account-id>?action=sync_inventory
Cloud Service Manager > Azure Accounts
Update a Azure account information
PUT /api/v1/csm/azure/accounts/<account-id>
Cloud Service Manager > Azure Accounts
Returns a list of desired regions for a particular Azure account
GET /api/v1/csm/azure/accounts/<account-id>/desired-regions
Cloud Service Manager > Azure Accounts
Updates the list of desired regions for a particular Azure account
PUT /api/v1/csm/azure/accounts/<account-id>/desired-regions
Cloud Service Manager > Azure Accounts
Returns the status of Azure account
GET /api/v1/csm/azure/accounts/<account-id>/status
Cloud Service Manager > Azure Gateways
Returns configuration information for all Azure gateways
GET /api/v1/csm/azure/gateways
Cloud Service Manager > Azure Gateways
Undeploys gateway for the specified virtual network
POST /api/v1/csm/azure/gateways?action=undeploy
Cloud Service Manager > Azure Gateways
Deploys gateway for the specified virtual network
POST /api/v1/csm/azure/gateways?action=deploy
Cloud Service Manager > Azure Gateways
Returns configuration of the Azure gateway
GET /api/v1/csm/azure/gateways/<vnet-id>
Cloud Service Manager > Azure Gateways
Updates Azure gateway configuration
PUT /api/v1/csm/azure/gateways/<vnet-id>
Cloud Service Manager > Azure Gateways
Return the status of Azure gateway
GET /api/v1/csm/azure/gateways/<vnet-id>/status
Cloud Service Manager > Azure IP Allocations
Returns IP allocations for all Azure Vnets. This operation is only supported for containers.
GET /api/v1/csm/azure/gateways/ip-mappings
Cloud Service Manager > Azure IP Allocations
Allocates IPs in the specified Azure Vnet
POST /api/v1/csm/azure/gateways/ip-mappings
Cloud Service Manager > Azure IP Allocations
Releases allocated IPs in the specified Azure Vnet
DELETE /api/v1/csm/azure/gateways/ip-mappings/<mapping-id>
Cloud Service Manager > Azure IP Allocations
Returns status information for primary gateway and secondary gateway for the vnet, if exists. This operation is only supported for containers.
GET /api/v1/csm/azure/gateways/ip-mappings/<mapping-id>/status
Cloud Service Manager > Azure Regions
Returns a list of Azure regions
GET /api/v1/csm/azure/regions
Cloud Service Manager > Azure Regions
Returns information about a particular Azure region
GET /api/v1/csm/azure/regions/<region-id>
Cloud Service Manager > Azure Resources
Returns a list of Azure public IPs
GET /api/v1/csm/azure/public-ips
Cloud Service Manager > Azure Resources
Returns a list of Azure security groups
GET /api/v1/csm/azure/resource-groups
Cloud Service Manager > Azure Resources
Returns a list of Azure Storage Accounts
GET /api/v1/csm/azure/storage-accounts
Cloud Service Manager > Azure Resources
Returns a list of Azure subnets
GET /api/v1/csm/azure/subnets
Cloud Service Manager > Azure Vnets
Returns the configuration of the compute VNet. The configuration contains quarantine policy and fall back security group of compute VNet and the information related to transit VNet.
GET /api/v1/csm/azure/compute-vnets
Cloud Service Manager > Azure Vnets
Offboards a compute VNet.
DELETE /api/v1/csm/azure/compute-vnets/<vnet-id>
Cloud Service Manager > Azure Vnets
Returns the configuration of the compute VNet. The configuration contains quarantine policy and fall back security group of compute VNet and the information related to transit VNet.
GET /api/v1/csm/azure/compute-vnets/<vnet-id>
Cloud Service Manager > Azure Vnets
Onboards a compute VNet to be NSX managed by a transit VNet.
POST /api/v1/csm/azure/compute-vnets/<vnet-id>
Cloud Service Manager > Azure Vnets
Updates the NSX configuration related to managed compute VNET using a transit VNET.
PUT /api/v1/csm/azure/compute-vnets/<vnet-id>
Cloud Service Manager > Azure Vnets
Returns the status of the compute VNet. The status corresponds to onboard or offboard status of a compute VNet.
GET /api/v1/csm/azure/compute-vnets/<vnet-id>/status
Cloud Service Manager > Azure Vnets
Returns a list of Azure virtual networks
GET /api/v1/csm/azure/vnets
Cloud Service Manager > Azure Vnets
Returns information about a particular Azure virtual network
GET /api/v1/csm/azure/vnets/<vnet-id>
Cloud Service Manager > Azure > Security Groups
Returns a list of Azure security groups corresponding to a VNet
GET /api/v1/csm/azure/security-groups
Cloud Service Manager > Azure > Security Groups
Returns information about a particular Azure security group
GET /api/v1/csm/azure/security-groups/<security-group-id>
Cloud Service Manager > Azure > Vnets > Service Endpoints
Returns a list of Azure service endpoints corresponding to a VNet
GET /api/v1/csm/azure/vnets/<vnet-id>/service-endpoints
Cloud Service Manager > Cloud Service Manager
Refreshes encryption keys
POST /api/v1/csm/csmconfig/encryption-keys?action=refresh
Cloud Service Manager > Cloud Service Manager
Return Csm status information
GET /api/v1/csm/csmstatus
Cloud Service Manager > Cloud Types
Return information on CSM cloud types
GET /api/v1/csm/desired-clouds
Cloud Service Manager > Cloud Types
Update the selection of CSM cloud types
PUT /api/v1/csm/desired-clouds
Cloud Service Manager > Manager Configuration
Read NSX Cloud Service Manager Nodes global configuration.
GET /api/v1/csm/configs/management
Cloud Service Manager > Manager Configuration
Update NSX Cloud Service Manager nodes global configuration
PUT /api/v1/csm/configs/management
Cloud Service Manager > NSX Manager Accounts
Returns a list of NSX Manager accounts
GET /api/v1/csm/nsx-manager-accounts
Cloud Service Manager > NSX Manager Accounts
Create a NSX Manager account
POST /api/v1/csm/nsx-manager-accounts
Cloud Service Manager > NSX Manager Accounts
Delete a NSX Manager account
DELETE /api/v1/csm/nsx-manager-accounts/<account-id>
Cloud Service Manager > NSX Manager Accounts
Returns the particular NSX Manager account information
GET /api/v1/csm/nsx-manager-accounts/<account-id>
Cloud Service Manager > NSX Manager Accounts
Update a NSX Manager account
PUT /api/v1/csm/nsx-manager-accounts/<account-id>
Cloud Service Manager > Proxy Server Profile
Returns a list of Proxy Server Profiles
GET /api/v1/csm/proxy-server-profiles
Cloud Service Manager > Proxy Server Profile
Create a Proxy Server Profile
POST /api/v1/csm/proxy-server-profiles
Cloud Service Manager > Proxy Server Profile
Delete a Proxy Server Profile
DELETE /api/v1/csm/proxy-server-profiles/<profile-id>
Cloud Service Manager > Proxy Server Profile
Returns the particular Proxy Server Profile information
GET /api/v1/csm/proxy-server-profiles/<profile-id>
Cloud Service Manager > Proxy Server Profile
Update a Proxy Server Profile
PUT /api/v1/csm/proxy-server-profiles/<profile-id>
Cloud Service Manager > Supported Regions
Returns supported regions per cloud
GET /api/v1/csm/supported-regions
Cloud Service Manager > System Configuration
Read NSX Cloud Service Manager system configuration.
GET /api/v1/csm/configs/system-config
Cloud Service Manager > System Configuration
Update NSX Cloud Service Manager system configuration.
PUT /api/v1/csm/configs/system-config
Cloud Service Manager > VPN
Returns all the NSX managed CSM VPN endpoints
GET /api/v1/csm/vpn/endpoints
Cloud Service Manager > VPN
Returns the state of the public cloud routing tables from a VPN point of view.
GET /api/v1/csm/vpn/routing-tables/state
Cloud Service Manager > VPN
Create a VPN session in cloud service manager.
POST /api/v1/csm/vpn/sessions
Cloud Service Manager > VPN
Delete a CSM VPN session
DELETE /api/v1/csm/vpn/sessions/<session-id>
Cloud Service Manager > VPN
Returns the details of the particular CSM VPN session
GET /api/v1/csm/vpn/sessions/<session-id>
Cloud Service Manager > VPN
Re-establish an existing CSM VPN session in errored state. If the create of an CSM VPN session errored out and the state is DOWN, this call can be made. CSM will attempt to re-create any missing NSX entities and attempt to re-establish the session.
POST /api/v1/csm/vpn/sessions/<session-id>?action=recreate
Cloud Service Manager > VPN
Update an existing CSM VPN session information
PUT /api/v1/csm/vpn/sessions/<session-id>
Cloud Service Manager > VPN
Returns the status and details of the particular CSM VPN session
GET /api/v1/csm/vpn/sessions/<session-id>/status
Cloud Service Manager > VPN
Returns the statuses of the CSM VPN sessions.
GET /api/v1/csm/vpn/sessions/status
Cloud Service Manager > Virtual Machines
Returns the list of all virtual machines created or imported under a particular account id. Supports optional query parameters like region id, vpc id, public_ip, is_gateway.
GET /api/v1/csm/virtual-machines
Cloud Service Manager > Virtual Machines
Update virtual machine config
POST /api/v1/csm/virtual-machines?action=update_config
Cloud Service Manager > Virtual Machines
Returns information about the particular virtual machine
GET /api/v1/csm/virtual-machines/<virtual-machine-id>
Cloud Service Manager > Virtual Machines > Firewall Rules
Details of NSX firewall rules of cloud virtual machine
GET /api/v1/csm/virtual-machines/<virtual-machine-id>/firewall-rules
Federation > Federation Configuration
Read federation config
GET /policy/api/v1/infra/federation-config
GET /policy/api/v1/global-infra/federation-config
Federation > Federation Configuration
Read Global Manager config along with sensitive data
GET /policy/api/v1/global-infra/global-manager-config?action=show-sensitive-data
Federation > Full Synchronization
Performs realized object actions specified in the action.
POST /policy/api/v1/infra/full-sync-action
Federation > Full Synchronization
List full sync states
GET /policy/api/v1/infra/full-sync-states
GET /policy/api/v1/global-infra/full-sync-states
Federation > Full Synchronization
Get full sync state
GET /policy/api/v1/infra/full-sync-states/<full-sync-id>
GET /policy/api/v1/global-infra/full-sync-states/<full-sync-id>
Federation > Global Managers
List Global Managers
GET /policy/api/v1/global-infra/global-managers
Federation > Global Managers
Read a Global Manager
GET /policy/api/v1/global-infra/global-managers/<global-manager-id>
Federation > Inter-Sites
Get inter-site status of the edge cluster
GET /api/v1/edge-clusters/<edge-cluster-id>/inter-site/status
Federation > Inter-Sites
Get infra segment cross site forwarder placement and HA status
GET /policy/api/v1/global-infra/segments/<segment-id>/inter-site-forwarder/site-span-info
Federation > Inter-Sites
Get infra segment cross site traffic statistics
GET /policy/api/v1/global-infra/segments/<segment-id>/inter-site-forwarder/status
Federation > Inter-Sites
Get RTEP span and mac address-table
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/inter-site/bgp-summary
Federation > Inter-Sites
Get RTEP mesh connectivity status
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/inter-site/status
Federation > Inter-Sites
Get segment cross site forwarder placement and HA status
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/inter-site-forwarder/site-span-info
Federation > Inter-Sites
Get segment cross site traffic statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/inter-site-forwarder/status
Federation > Inter-Sites
Get L2 forwarder remote mac addresses
GET /api/v1/logical-switches/<logical-switch-id>/inter-site-forwarder/site-span-info (Experimental)
Federation > Inter-Sites
Get L2 forwarder statistics
GET /api/v1/logical-switches/<logical-switch-id>/inter-site-forwarder/statistics (Experimental)
Federation > Inter-Sites
Get L2 forwarder status
GET /api/v1/logical-switches/<logical-switch-id>/inter-site-forwarder/status (Experimental) (Deprecated)
Federation > Inter-Sites
Paginated list of BGP Neighbors on edge transport node
GET /api/v1/transport-nodes/<edge-node-id>/inter-site/bgp/neighbors
Federation > Inter-Sites
Get BGP neighbor advertised routes on edge transport node
GET /api/v1/transport-nodes/<edge-node-id>/inter-site/bgp/neighbors/<neighbor-id>/advertised-routes
Federation > Inter-Sites
Get BGP neighbor learned routes on edge transport node
GET /api/v1/transport-nodes/<edge-node-id>/inter-site/bgp/neighbors/<neighbor-id>/routes
Federation > Inter-Sites
Get inter-site BGP summary of edge node
GET /api/v1/transport-nodes/<edge-node-id>/inter-site/bgp/summary (Deprecated)
Federation > Inter-Sites
Get inter-site statistics of edge node
GET /api/v1/transport-nodes/<edge-node-id>/inter-site/statistics
Federation > Observability
Get monitoring info
GET /policy/api/v1/observability/flow-details
Federation > Sites
Get site offboarding status.
GET /policy/api/v1/infra/site/offboarding-status
Federation > Sites
List Sites
GET /policy/api/v1/global-infra/sites
GET /policy/api/v1/infra/sites
Federation > Sites
Delete a site
DELETE /policy/api/v1/infra/sites/<site-id>
Federation > Sites
Read a site
GET /policy/api/v1/infra/sites/<site-id>
GET /policy/api/v1/global-infra/sites/<site-id>
Federation > Sites
Create or patch Site
PATCH /policy/api/v1/infra/sites/<site-id>
Federation > Sites
Create or fully replace a Site under infra
PUT /policy/api/v1/infra/sites/<site-id>
Federation > Sites
Returns the certificate of the listener
GET /policy/api/v1/global-infra/sites/listener_certificate
GET /policy/api/v1/infra/sites/listener_certificate
Federation > Sites
Get span for an entity with specified path
GET /policy/api/v1/infra/span
GET /policy/api/v1/global-infra/span
Management Plane API > Associations
Get ResourceReference objects to which the given resource belongs to
GET /api/v1/associations
Management Plane API > Grouping Objects > IP Sets
List IPSets
GET /api/v1/ip-sets
Management Plane API > Grouping Objects > IP Sets
Delete IPSet
DELETE /api/v1/ip-sets/<ip-set-id>
Management Plane API > Grouping Objects > IP Sets
Read IPSet
GET /api/v1/ip-sets/<ip-set-id>
Management Plane API > Grouping Objects > IP Sets
Add a IP address to a IPSet
POST /api/v1/ip-sets/<ip-set-id>
Management Plane API > Grouping Objects > IP Sets
Update IPSet
PUT /api/v1/ip-sets/<ip-set-id>
Management Plane API > Grouping Objects > IP Sets
Get all IPAddresses in a IPSet
GET /api/v1/ip-sets/<ip-set-id>/members
Management Plane API > Grouping Objects > IP Sets
Create MACSet
POST /api/v1/mac-sets
Management Plane API > Grouping Objects > MAC Sets
List MACSets
GET /api/v1/mac-sets
Management Plane API > Grouping Objects > MAC Sets
Delete MACSet
DELETE /api/v1/mac-sets/<mac-set-id>
Management Plane API > Grouping Objects > MAC Sets
Read MACSet
GET /api/v1/mac-sets/<mac-set-id>
Management Plane API > Grouping Objects > MAC Sets
Update MACSet
PUT /api/v1/mac-sets/<mac-set-id>
Management Plane API > Grouping Objects > MAC Sets
Get all MACAddresses in a MACSet
GET /api/v1/mac-sets/<mac-set-id>/members
Management Plane API > Grouping Objects > MAC Sets
Add a MAC address to a MACSet
POST /api/v1/mac-sets/<mac-set-id>/members
Management Plane API > Grouping Objects > MAC Sets
Remove a MAC address from given MACSet
DELETE /api/v1/mac-sets/<mac-set-id>/members/<mac-address>
Management Plane API > Grouping Objects > NS Groups
List NSGroups
GET /api/v1/ns-groups
Management Plane API > Grouping Objects > NS Groups
Create NSGroup
POST /api/v1/ns-groups
Management Plane API > Grouping Objects > NS Groups
Delete NSGroup
DELETE /api/v1/ns-groups/<ns-group-id>
Management Plane API > Grouping Objects > NS Groups
Read NSGroup
GET /api/v1/ns-groups/<ns-group-id>
Management Plane API > Grouping Objects > NS Groups
Add NSGroup expression
POST /api/v1/ns-groups/<ns-group-id>
Management Plane API > Grouping Objects > NS Groups
Update NSGroup
PUT /api/v1/ns-groups/<ns-group-id>
Management Plane API > Grouping Objects > NS Groups
Get consolidated Effective IPAddress translated from the NSGroup
GET /api/v1/ns-groups/<ns-group-id>/consolidated-effective-ip-address-members
Management Plane API > Grouping Objects > NS Groups
Get Effective Cloud Native Service Instances of the specified NSGroup.
GET /api/v1/ns-groups/<ns-group-id>/effective-cloud-native-service-instance-members
Management Plane API > Grouping Objects > NS Groups
Get Effective Directory Groups of the specified NSGroup.
GET /api/v1/ns-groups/<ns-group-id>/effective-directory-group-members
Management Plane API > Grouping Objects > NS Groups
Get Effective IPAddress translated from the NSGroup
GET /api/v1/ns-groups/<ns-group-id>/effective-ip-address-members
Management Plane API > Grouping Objects > NS Groups
Get Effective IPSets of the specified NSGroup.
GET /api/v1/ns-groups/<ns-group-id>/effective-ipset-members
Management Plane API > Grouping Objects > NS Groups
Get Effective Logical Ports translated from the NSgroup
GET /api/v1/ns-groups/<ns-group-id>/effective-logical-port-members
Management Plane API > Grouping Objects > NS Groups
Get Effective switch members translated from the NSGroup
GET /api/v1/ns-groups/<ns-group-id>/effective-logical-switch-members
Management Plane API > Grouping Objects > NS Groups
Get Effective Physical Server Memebers of the specified NSGroup.
GET /api/v1/ns-groups/<ns-group-id>/effective-physical-server-members
Management Plane API > Grouping Objects > NS Groups
Get effective transport node members translated from the NSGroup
GET /api/v1/ns-groups/<ns-group-id>/effective-transport-node-members
Management Plane API > Grouping Objects > NS Groups
Get effective VIF members translated from the NSGroup
GET /api/v1/ns-groups/<ns-group-id>/effective-vif-members
Management Plane API > Grouping Objects > NS Groups
Get Effective Virtual Machine members of the specified NSGroup.
GET /api/v1/ns-groups/<ns-group-id>/effective-virtual-machine-members
Management Plane API > Grouping Objects > NS Groups
Get member types from NSGroup
GET /api/v1/ns-groups/<ns-group-id>/member-types
Management Plane API > Grouping Objects > NS Groups
Get services to which the given nsgroup belongs to
GET /api/v1/ns-groups/<nsgroup-id>/service-associations
Management Plane API > Grouping Objects > NS Groups
Get the list of all the virtual machines that are not a part of any existing NSGroup.
GET /api/v1/ns-groups/unassociated-virtual-machines
Management Plane API > Grouping Objects > NS Groups
Create NSProfile
POST /api/v1/ns-profiles
Management Plane API > Grouping Objects > NS Profiles
Create IPSet
POST /api/v1/ip-sets
Management Plane API > Grouping Objects > NS Profiles
List NSProfiles
GET /api/v1/ns-profiles
Management Plane API > Grouping Objects > NS Profiles
Delete NSProfile
DELETE /api/v1/ns-profiles/<ns-profile-id>
Management Plane API > Grouping Objects > NS Profiles
Read NSProfile
GET /api/v1/ns-profiles/<ns-profile-id>
Management Plane API > Grouping Objects > NS Profiles
Update NSProfile
PUT /api/v1/ns-profiles/<ns-profile-id>
Management Plane API > Grouping Objects > NS Profiles
List NSProfile supported attribute types
GET /api/v1/ns-profiles/attribute-types
Management Plane API > Grouping Objects > NS Profiles
List NSProfile supported attribute and sub-attributes
GET /api/v1/ns-profiles/attributes
Management Plane API > Grouping Objects > NS Service Groups
List all NSServiceGroups
GET /api/v1/ns-service-groups
Management Plane API > Grouping Objects > NS Service Groups
Delete NSServiceGroup
DELETE /api/v1/ns-service-groups/<ns-service-group-id>
Management Plane API > Grouping Objects > NS Service Groups
Read NSServiceGroup
GET /api/v1/ns-service-groups/<ns-service-group-id>
Management Plane API > Grouping Objects > NS Service Groups
Update NSServiceGroup
PUT /api/v1/ns-service-groups/<ns-service-group-id>
Management Plane API > Grouping Objects > NS Services
Create NSServiceGroup
POST /api/v1/ns-service-groups
Management Plane API > Grouping Objects > NS Services
List all NSServices
GET /api/v1/ns-services
Management Plane API > Grouping Objects > NS Services
Create NSService
POST /api/v1/ns-services
Management Plane API > Grouping Objects > NS Services
Delete NSService
DELETE /api/v1/ns-services/<ns-service-id>
Management Plane API > Grouping Objects > NS Services
Read NSService
GET /api/v1/ns-services/<ns-service-id>
Management Plane API > Grouping Objects > NS Services
Update NSService
PUT /api/v1/ns-services/<ns-service-id>
Management Plane API > NSX Component Administration > Appliance Management
Read the Appliance Proxy service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/applianceproxy
GET /api/v1/node/services/applianceproxy
Management Plane API > NSX Component Administration > Appliance Management
Restart, start or stop the Appliance Proxy Service
POST /api/v1/node/services/applianceproxy?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/applianceproxy?action=restart|start|stop
Management Plane API > NSX Component Administration > Appliance Management
Read the Appliance Proxy service status
GET /api/v1/node/services/applianceproxy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/applianceproxy/status
Management Plane API > Networking > Logical Bridging > Bridge Endpoint Profiles
List All Bridge Endpoint Profiles
GET /api/v1/bridge-endpoint-profiles
Management Plane API > Networking > Logical Bridging > Bridge Endpoint Profiles
Create a Bridge Endpoint Profile
POST /api/v1/bridge-endpoint-profiles
Management Plane API > Networking > Logical Bridging > Bridge Endpoint Profiles
Delete a Bridge Endpoint Profile
DELETE /api/v1/bridge-endpoint-profiles/<bridgeendpointprofile-id>
Management Plane API > Networking > Logical Bridging > Bridge Endpoint Profiles
Get Information about a bridge endpoint Profile
GET /api/v1/bridge-endpoint-profiles/<bridgeendpointprofile-id>
Management Plane API > Networking > Logical Bridging > Bridge Endpoint Profiles
Update a Bridge Endpoint Profile
PUT /api/v1/bridge-endpoint-profiles/<bridgeendpointprofile-id>
Management Plane API > Networking > Logical Bridging > Bridge Endpoints
List All Bridge Endpoints
GET /api/v1/bridge-endpoints
Management Plane API > Networking > Logical Bridging > Bridge Endpoints
Create a Bridge Endpoint
POST /api/v1/bridge-endpoints (Deprecated)
Management Plane API > Networking > Logical Bridging > Bridge Endpoints
Delete a Bridge Endpoint
DELETE /api/v1/bridge-endpoints/<bridgeendpoint-id> (Deprecated)
Management Plane API > Networking > Logical Bridging > Bridge Endpoints
Get Information about a bridge endpoint
GET /api/v1/bridge-endpoints/<bridgeendpoint-id>
Management Plane API > Networking > Logical Bridging > Bridge Endpoints
Update a Bridge Endpoint
PUT /api/v1/bridge-endpoints/<bridgeendpoint-id> (Deprecated)
Management Plane API > Networking > Logical Bridging > Bridge Endpoints
Returns statistics of a specified Bridge Endpoint
GET /api/v1/bridge-endpoints/<endpoint-id>/statistics
Management Plane API > Networking > Logical Bridging > Bridge Endpoints
Returns status of a specified Bridge Endpoint
GET /api/v1/bridge-endpoints/<endpoint-id>/status
Management Plane API > Networking > Logical Routing And Services > BFD Peers
List static routes BFD Peers
GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers
Management Plane API > Networking > Logical Routing And Services > BFD Peers
Create a static hop BFD peer
POST /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers
Management Plane API > Networking > Logical Routing And Services > BFD Peers
Delete a specified static route BFD peer cofigured on a specified logical router
DELETE /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers/<bfd-peer-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > BFD Peers
Read a static route BFD peer
GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers/<bfd-peer-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > BFD Peers
Update a static route BFD peer
PUT /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers/<bfd-peer-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
List Logical Router Ports
GET /api/v1/logical-router-ports (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Create a Logical Router Port
POST /api/v1/logical-router-ports (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Delete a Logical Router Port
DELETE /api/v1/logical-router-ports/<logical-router-port-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Read Logical Router Port
GET /api/v1/logical-router-ports/<logical-router-port-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Update a Logical Router Port
PUT /api/v1/logical-router-ports/<logical-router-port-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the Logical Router Port of the given id
GET /api/v1/logical-router-ports/<logical-router-port-id>/arp-table (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the Logical Router Port of the given id
GET /api/v1/logical-router-ports/<logical-router-port-id>/arp-table?format=csv (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Get the Realized State of a Logical Router Port
GET /api/v1/logical-router-ports/<logical-router-port-id>/state (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Get the statistics of a specified logical router port on all or a specified node
GET /api/v1/logical-router-ports/<logical-router-port-id>/statistics (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Router Ports
Get the statistics summary of a specified logical router port
GET /api/v1/logical-router-ports/<logical-router-port-id>/statistics/summary (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
List Logical Routers
GET /api/v1/logical-routers (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Create a Logical Router
POST /api/v1/logical-routers (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Delete a Logical Router
DELETE /api/v1/logical-routers/<logical-router-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Read Logical Router
GET /api/v1/logical-routers/<logical-router-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Re allocate edge node placement of TIER1 service routers
POST /api/v1/logical-routers/<logical-router-id>?action=reallocate (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Reprocesses a logical router configuration and publish updates to controller
POST /api/v1/logical-routers/<logical-router-id>?action=reprocess (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Update a Logical Router
PUT /api/v1/logical-routers/<logical-router-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get BGP neighbor advertised routes
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/advertised-routes (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get BGP neighbor advertised routes in CSV format
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/advertised-routes?format=csv (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get BGP neighbor learned routes in CSV format
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/routes?format=csv (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get BGP neighbor learned routes
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/routes (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get the status of all the BGP neighbors for the Logical Router of the given id
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/status (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get FIB table on a specified node for a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/forwarding-table (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get FIB table on a specified node for a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/forwarding-table?format=csv (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get route table on a node for a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/route-table?format=csv (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get route table on a given node for a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/route-table (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get RIB table on a specified node for a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/routing-table (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get RIB table on a specified node for a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/routing-table?format=csv (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get the Realized State of a Logical Service Router Cluster
GET /api/v1/logical-routers/<logical-router-id>/service-cluster/state (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get the Realized State of a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/state (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Logical Routers
Get the status for the Logical Router of the given id
GET /api/v1/logical-routers/<logical-router-id>/status (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
List NAT rules of the logical router
GET /api/v1/logical-routers/<logical-router-id>/nat/rules (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
Add multiple NAT rules in a specific logical router
POST /api/v1/logical-routers/<logical-router-id>/nat/rules?action=create_multiple
Management Plane API > Networking > Logical Routing And Services > NAT
Add a NAT rule in a specific logical router
POST /api/v1/logical-routers/<logical-router-id>/nat/rules (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
Delete a specific NAT rule from a logical router
DELETE /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
Get a specific NAT rule from a given logical router
GET /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
Update a specific NAT rule from a given logical router
PUT /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
Get the statistics of a specified logical router NAT Rule
GET /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id>/statistics (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
Get the statistics of all rules of the logical router
GET /api/v1/logical-routers/<logical-router-id>/nat/rules/statistics (Deprecated)
Management Plane API > Networking > Logical Routing And Services > NAT
Get statistics for all logical router NAT rules on a transport node
GET /api/v1/transport-nodes/<node-id>/statistics/nat-rules
Management Plane API > Networking > Logical Routing And Services > Routing BFD Configuration
Read the Routing BFD Configuration
GET /api/v1/logical-routers/<logical-router-id>/routing/bfd-config
Management Plane API > Networking > Logical Routing And Services > Routing BFD Configuration
Update the BFD Configuration for BFD peers for routing
PUT /api/v1/logical-routers/<logical-router-id>/routing/bfd-config
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read All IPV6 DADProfiles
GET /api/v1/ipv6/dad-profiles (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Create a new DADProfile
POST /api/v1/ipv6/dad-profiles (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Delete DAD Profile
DELETE /api/v1/ipv6/dad-profiles/<dad-profile-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read specified IPV6 DADProfile
GET /api/v1/ipv6/dad-profiles/<dad-profile-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update DADProfile
PUT /api/v1/ipv6/dad-profiles/<dad-profile-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read All IPV6 NDRA Profiles
GET /api/v1/ipv6/nd-ra-profiles (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Create a new NDRA Profile
POST /api/v1/ipv6/nd-ra-profiles (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Delete NDRA Profile
DELETE /api/v1/ipv6/nd-ra-profiles/<nd-ra-profile-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read specified IPV6 NDRA Profile
GET /api/v1/ipv6/nd-ra-profiles/<nd-ra-profile-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update NDRA Profile
PUT /api/v1/ipv6/nd-ra-profiles/<nd-ra-profile-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read the debug information for the logical router
GET /api/v1/logical-routers/<logical-router-id>/debug-info?format=text
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read the Routing Configuration
GET /api/v1/logical-routers/<logical-router-id>/routing
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update the Routing Configuration
PUT /api/v1/logical-routers/<logical-router-id>/routing
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read the Advertisement Configuration on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/advertisement
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update the Advertisement Configuration on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/advertisement (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read the Advertisement Rules on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/advertisement/rules
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update the Advertisement Rules on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/advertisement/rules (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read the BGP Configuration on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update the BGP Configuration on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Paginated list of BGP community lists on a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Create a new BGP community list on a logical router
POST /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Delete a specific BGP community list from a logical router
DELETE /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists/<community-list-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read a specific BGP community list from a logical router
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists/<community-list-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update a specific BGP community list from a logical router
PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists/<community-list-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update a specific BGP community list from a logical router
PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp/communty-lists/<community-list-id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Paginated list of BGP Neighbors on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Add a new BGP Neighbor on a Logical Router
POST /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Delete a specific BGP Neighbor on a Logical Router
DELETE /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read a specific BGP Neighbor with password on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id>?action=show-sensitive-data
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read a specific BGP Neighbor on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Unset/Delete password property on specific BGP Neighbor on Logical Router
POST /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update a specific BGP Neighbor on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Paginated List of IPPrefixLists
GET /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Add IPPrefixList on a Logical Router
POST /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Delete a specific IPPrefixList on a Logical Router
DELETE /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Get a specific IPPrefixList on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update a specific IPPrefixList on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read the Redistribution Configuration on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/redistribution
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update the Redistribution Configuration on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/redistribution (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Read All the Redistribution Rules on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/redistribution/rules
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update All the Redistribution Rules on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/redistribution/rules (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Paginated List of RouteMaps
GET /api/v1/logical-routers/<logical-router-id>/routing/route-maps (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Add RouteMap on a Logical Router
POST /api/v1/logical-routers/<logical-router-id>/routing/route-maps (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Delete a specific RouteMap on a Logical Router
DELETE /api/v1/logical-routers/<logical-router-id>/routing/route-maps/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Get a specific RouteMap on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/route-maps/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update a specific RouteMap on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/route-maps/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Paginated List of Static Routes
GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Add Static Routes on a Logical Router
POST /api/v1/logical-routers/<logical-router-id>/routing/static-routes (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Delete a specific Static Route on a Logical Router
DELETE /api/v1/logical-routers/<logical-router-id>/routing/static-routes/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Get a specific Static Route on a Logical Router
GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes/<id> (Deprecated)
Management Plane API > Networking > Logical Routing And Services > Routing Configuration
Update a specific Static Route Rule on a Logical Router
PUT /api/v1/logical-routers/<logical-router-id>/routing/static-routes/<id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
List All Logical Ports
GET /api/v1/logical-ports (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Create a Logical Port
POST /api/v1/logical-ports (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Delete a Logical Port
DELETE /api/v1/logical-ports/<lport-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get Information About a Logical Port
GET /api/v1/logical-ports/<lport-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Update a Logical Port
PUT /api/v1/logical-ports/<lport-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get MAC table of a logical port with a given port id (lport-id)
GET /api/v1/logical-ports/<lport-id>/mac-table
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get MAC table of a logical port with a given port id (lport-id)
GET /api/v1/logical-ports/<lport-id>/mac-table?format=csv
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get realized state & location of a logical port
GET /api/v1/logical-ports/<lport-id>/state (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get Statistics for Logical Port of a Given Port ID (lport-id)
GET /api/v1/logical-ports/<lport-id>/statistics
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get Operational Status for Logical Port of a Given Port ID (lport-id)
GET /api/v1/logical-ports/<lport-id>/status
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get Operational Status Summary of All Logical Ports in the System
GET /api/v1/logical-ports/status
Management Plane API > Networking > Logical Switching > Logical Switch Ports
List Switching Profiles
GET /api/v1/switching-profiles (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Create a Switching Profile
POST /api/v1/switching-profiles (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Delete a Switching Profile
DELETE /api/v1/switching-profiles/<switching-profile-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get Switching Profile by ID
GET /api/v1/switching-profiles/<switching-profile-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Update a Switching Profile
PUT /api/v1/switching-profiles/<switching-profile-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switch Ports
Get Counts of Ports and Switches Using This Switching Profile
GET /api/v1/switching-profiles/<switching-profile-id>/summary (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
List all Logical Switches
GET /api/v1/logical-switches (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Create a Logical Switch
POST /api/v1/logical-switches (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Delete a Logical Switch
DELETE /api/v1/logical-switches/<lswitch-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Get Logical Switch associated with the provided id (lswitch-id)
GET /api/v1/logical-switches/<lswitch-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Update a Logical Switch
PUT /api/v1/logical-switches/<lswitch-id> (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Get MAC Table for Logical Switch of the Given ID (lswitch-id)
GET /api/v1/logical-switches/<lswitch-id>/mac-table
Management Plane API > Networking > Logical Switching > Logical Switches
Get MAC Table for Logical Switch of the Given ID (lswitch-id)
GET /api/v1/logical-switches/<lswitch-id>/mac-table?format=csv
Management Plane API > Networking > Logical Switching > Logical Switches
Get the realized state associated with provided logical switch id
GET /api/v1/logical-switches/<lswitch-id>/state (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Get Statistics for Logical Switch of the Given ID (lswitch-id)
GET /api/v1/logical-switches/<lswitch-id>/statistics
Management Plane API > Networking > Logical Switching > Logical Switches
Get Logical Switch runtime status info for a given logical switch
GET /api/v1/logical-switches/<lswitch-id>/summary (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id)
GET /api/v1/logical-switches/<lswitch-id>/vtep-table
Management Plane API > Networking > Logical Switching > Logical Switches
Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id)
GET /api/v1/logical-switches/<lswitch-id>/vtep-table?format=csv
Management Plane API > Networking > Logical Switching > Logical Switches
List logical switches by realized state
GET /api/v1/logical-switches/state (Deprecated)
Management Plane API > Networking > Logical Switching > Logical Switches
Get Status Summary of All Logical Switches in the System
GET /api/v1/logical-switches/status
Management Plane API > Networking > Services > DHCP
Get a paginated list of DHCP server profiles
GET /api/v1/dhcp/server-profiles (Deprecated)
Management Plane API > Networking > Services > DHCP
Create a DHCP server profile
POST /api/v1/dhcp/server-profiles (Deprecated)
Management Plane API > Networking > Services > DHCP
Delete a DHCP server profile
DELETE /api/v1/dhcp/server-profiles/<profile-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a DHCP server profile
GET /api/v1/dhcp/server-profiles/<profile-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Update a DHCP server profile
PUT /api/v1/dhcp/server-profiles/<profile-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Reallocate edge cluster and members of given DHCP profile.
POST /api/v1/dhcp/server-profiles/<server-profile-id>?action=reallocate (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a paginated list of DHCP servers
GET /api/v1/dhcp/servers (Deprecated)
Management Plane API > Networking > Services > DHCP
Create a DHCP server
POST /api/v1/dhcp/servers (Deprecated)
Management Plane API > Networking > Services > DHCP
Delete a DHCP server
DELETE /api/v1/dhcp/servers/<server-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a DHCP server with v4 and/or v6 servers
GET /api/v1/dhcp/servers/<server-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Update a DHCP server with v4 and/or v6 servers
PUT /api/v1/dhcp/servers/<server-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a paginated list of a DHCP server's IP pools
GET /api/v1/dhcp/servers/<server-id>/ip-pools (Deprecated)
Management Plane API > Networking > Services > DHCP
Create an ip pool for a DHCP server
POST /api/v1/dhcp/servers/<server-id>/ip-pools (Deprecated)
Management Plane API > Networking > Services > DHCP
Delete a DHCP server's IP pool
DELETE /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a DHCP server's IP pool with the specified pool ID
GET /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Update a DHCP server's IP pool
PUT /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get the realized state of a dhcp ip pool
GET /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id>/state (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a paginated list of a DHCP IPv6 server's IP pools
GET /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools (Deprecated)
Management Plane API > Networking > Services > DHCP
Create an ip pool for a DHCP IPv6 server
POST /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools (Deprecated)
Management Plane API > Networking > Services > DHCP
Delete a DHCP IPv6 server's IP pool
DELETE /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a DHCP IPv6 server's IP pool with the specified pool ID
GET /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Update a DHCP IPv6 server's IP pool
PUT /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a paginated list of a DHCP IPv6 server's static bindings
GET /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings (Deprecated)
Management Plane API > Networking > Services > DHCP
Create a static binding for a DHCP IPv6 server
POST /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings (Deprecated)
Management Plane API > Networking > Services > DHCP
Delete a static binding for DHCP IPv6 server
DELETE /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings/<binding-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a DHCP IPv6 server's static binding with the specified binding ID
GET /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings/<binding-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Update a DHCP IPv6 server's static binding
PUT /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings/<binding-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Delete a single DHCP lease entry specified by ip and mac.
DELETE /api/v1/dhcp/servers/<server-id>/leases
Management Plane API > Networking > Services > DHCP
Get the realized state of a dhcp server
GET /api/v1/dhcp/servers/<server-id>/state (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a paginated list of a DHCP server's static bindings
GET /api/v1/dhcp/servers/<server-id>/static-bindings (Deprecated)
Management Plane API > Networking > Services > DHCP
Create a static binding for a DHCP server
POST /api/v1/dhcp/servers/<server-id>/static-bindings (Deprecated)
Management Plane API > Networking > Services > DHCP
Delete a static binding
DELETE /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get a DHCP server's static binding with the specified binding ID
GET /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Update a DHCP server's static binding
PUT /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id> (Deprecated)
Management Plane API > Networking > Services > DHCP
Get the realized state of a dhcp static binding
GET /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id>/state (Deprecated)
Management Plane API > Networking > Services > DHCP
Get DHCP service status with given dhcp server id
GET /api/v1/dhcp/servers/<server-id>/status (Deprecated)
Management Plane API > Networking > Services > DHCP Relay
List all DHCP Relay Services
GET /api/v1/dhcp/relays (Deprecated)
Management Plane API > Networking > Services > DHCP Relay
Create a DHCP Relay Service
POST /api/v1/dhcp/relays (Deprecated)
Management Plane API > Networking > Services > DHCP Relay
Delete a DHCP Relay Service
DELETE /api/v1/dhcp/relays/<relay-id> (Deprecated)
Management Plane API > Networking > Services > DHCP Relay
Read a DHCP Relay Service
GET /api/v1/dhcp/relays/<relay-id> (Deprecated)
Management Plane API > Networking > Services > DHCP Relay
Update a DHCP Relay Service
PUT /api/v1/dhcp/relays/<relay-id> (Deprecated)
Management Plane API > Networking > Services > DHCP Relay Profiles
List All DHCP Relay Profiles
GET /api/v1/dhcp/relay-profiles (Deprecated)
Management Plane API > Networking > Services > DHCP Relay Profiles
Create a DHCP Relay Profile
POST /api/v1/dhcp/relay-profiles (Deprecated)
Management Plane API > Networking > Services > DHCP Relay Profiles
Delete a DHCP Relay Profile
DELETE /api/v1/dhcp/relay-profiles/<relay-profile-id> (Deprecated)
Management Plane API > Networking > Services > DHCP Relay Profiles
Read a DHCP Relay Profile
GET /api/v1/dhcp/relay-profiles/<relay-profile-id> (Deprecated)
Management Plane API > Networking > Services > DHCP Relay Profiles
Update a DHCP Relay Profile
PUT /api/v1/dhcp/relay-profiles/<relay-profile-id> (Deprecated)
Management Plane API > Networking > Services > DNS
Get a paginated list of DNS forwarders
GET /api/v1/dns/forwarders (Deprecated)
Management Plane API > Networking > Services > DNS
Create a DNS forwader
POST /api/v1/dns/forwarders (Deprecated)
Management Plane API > Networking > Services > DNS
Delete a specific DNS forwarder
DELETE /api/v1/dns/forwarders/<forwarder-id> (Deprecated)
Management Plane API > Networking > Services > DNS
Retrieve a DNS forwarder
GET /api/v1/dns/forwarders/<forwarder-id> (Deprecated)
Management Plane API > Networking > Services > DNS
Clear the current cache of the DNS forwarder.
POST /api/v1/dns/forwarders/<forwarder-id>?action=clear_cache (Deprecated)
Management Plane API > Networking > Services > DNS
Enable the DNS forwarder.
POST /api/v1/dns/forwarders/<forwarder-id>?action=enable
Management Plane API > Networking > Services > DNS
Disable the DNS forwarder.
POST /api/v1/dns/forwarders/<forwarder-id>?action=disable
Management Plane API > Networking > Services > DNS
Update a specific DNS forwarder
PUT /api/v1/dns/forwarders/<forwarder-id> (Deprecated)
Management Plane API > Networking > Services > DNS
Get the recent failed DNS queries
GET /api/v1/dns/forwarders/<forwarder-id>/failed-queries
Management Plane API > Networking > Services > DNS
Resolve a given address via the DNS forwarder
GET /api/v1/dns/forwarders/<forwarder-id>/nslookup (Deprecated)
Management Plane API > Networking > Services > DNS
Get the realized state of a DNS forwarder
GET /api/v1/dns/forwarders/<forwarder-id>/state (Deprecated)
Management Plane API > Networking > Services > DNS
Get current status of the given DNS forwarder
GET /api/v1/dns/forwarders/<forwarder-id>/status (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer application profiles
GET /api/v1/loadbalancer/application-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer application profile
POST /api/v1/loadbalancer/application-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer application profile
DELETE /api/v1/loadbalancer/application-profiles/<application-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer application profile
GET /api/v1/loadbalancer/application-profiles/<application-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer application profile
PUT /api/v1/loadbalancer/application-profiles/<application-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer client-ssl profiles
GET /api/v1/loadbalancer/client-ssl-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer client-ssl profile
POST /api/v1/loadbalancer/client-ssl-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer client-ssl profile
DELETE /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer client-ssl profile
GET /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer client-ssl profile
PUT /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer monitors
GET /api/v1/loadbalancer/monitors (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer monitor
POST /api/v1/loadbalancer/monitors (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer monitor
DELETE /api/v1/loadbalancer/monitors/<monitor-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer monitor
GET /api/v1/loadbalancer/monitors/<monitor-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer monitor
PUT /api/v1/loadbalancer/monitors/<monitor-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Read load balancer node usage summary
GET /api/v1/loadbalancer/node-usage-summary (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer persistence profiles
GET /api/v1/loadbalancer/persistence-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer persistence profile
POST /api/v1/loadbalancer/persistence-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer persistence profile
DELETE /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer persistence profile
GET /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer persistence profile
PUT /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer pools
GET /api/v1/loadbalancer/pools (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer pool
POST /api/v1/loadbalancer/pools (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer pool
DELETE /api/v1/loadbalancer/pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer pool
GET /api/v1/loadbalancer/pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Add, remove, or modify load balancer pool members
POST /api/v1/loadbalancer/pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer pool
PUT /api/v1/loadbalancer/pools/<pool-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer rules
GET /api/v1/loadbalancer/rules (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer rule
POST /api/v1/loadbalancer/rules (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer rule
DELETE /api/v1/loadbalancer/rules/<rule-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer rule
GET /api/v1/loadbalancer/rules/<rule-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer rule
PUT /api/v1/loadbalancer/rules/<rule-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer server-ssl profiles
GET /api/v1/loadbalancer/server-ssl-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer server-ssl profile
POST /api/v1/loadbalancer/server-ssl-profiles (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer server-ssl profile
DELETE /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer server-ssl profile
GET /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer server-ssl profile
PUT /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer services
GET /api/v1/loadbalancer/services (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer service
POST /api/v1/loadbalancer/services (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer service
DELETE /api/v1/loadbalancer/services/<service-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer service
GET /api/v1/loadbalancer/services/<service-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer service
PUT /api/v1/loadbalancer/services/<service-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Read the debug information of the load balancer service
GET /api/v1/loadbalancer/services/<service-id>/debug-info
Management Plane API > Networking > Services > Loadbalancer
Get the statistics of load balancer pool
GET /api/v1/loadbalancer/services/<service-id>/pools/<pool-id>/statistics (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the status of load balancer pool
GET /api/v1/loadbalancer/services/<service-id>/pools/<pool-id>/status (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the statistics list of load balancer pools
GET /api/v1/loadbalancer/services/<service-id>/pools/statistics (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the status list of load balancer pools
GET /api/v1/loadbalancer/services/<service-id>/pools/status (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the statistics of load balancer service
GET /api/v1/loadbalancer/services/<service-id>/statistics (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the status of the given load balancer service
GET /api/v1/loadbalancer/services/<service-id>/status (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Read the usage information of the given load balancer service
GET /api/v1/loadbalancer/services/<service-id>/usage (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the statistics of the given load balancer virtual server
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/<virtual-server-id>/statistics (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the status of the load balancer virtual server
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/<virtual-server-id>/status (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the statistics list of virtual servers
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/statistics (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Get the status list of virtual servers in given load balancer service
GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/status (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a list of supported SSL ciphers and protocols
GET /api/v1/loadbalancer/ssl/ciphers-and-protocols (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Read load balancer usage for the given node
GET /api/v1/loadbalancer/usage-per-node/<node-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a paginated list of load balancer virtual servers
GET /api/v1/loadbalancer/virtual-servers (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer virtual server
POST /api/v1/loadbalancer/virtual-servers (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Create a load balancer virtual server with rules
POST /api/v1/loadbalancer/virtual-servers?action=create_with_rules (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Delete a load balancer virtual server
DELETE /api/v1/loadbalancer/virtual-servers/<virtual-server-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Retrieve a load balancer virtual server
GET /api/v1/loadbalancer/virtual-servers/<virtual-server-id> (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer virtual server with rules
PUT /api/v1/loadbalancer/virtual-servers/<virtual-server-id>?action=update_with_rules (Deprecated)
Management Plane API > Networking > Services > Loadbalancer
Update a load balancer virtual server
PUT /api/v1/loadbalancer/virtual-servers/<virtual-server-id> (Deprecated)
Management Plane API > Networking > Services > Metadata Proxy
Get a paginated list of metadata proxies
GET /api/v1/md-proxies (Deprecated)
Management Plane API > Networking > Services > Metadata Proxy
Create a metadata proxy
POST /api/v1/md-proxies (Deprecated)
Management Plane API > Networking > Services > Metadata Proxy
Delete a metadata proxy
DELETE /api/v1/md-proxies/<proxy-id> (Deprecated)
Management Plane API > Networking > Services > Metadata Proxy
Get a metadata proxy
GET /api/v1/md-proxies/<proxy-id> (Deprecated)
Management Plane API > Networking > Services > Metadata Proxy
Update a metadata proxy
PUT /api/v1/md-proxies/<proxy-id> (Deprecated)
Management Plane API > Networking > Services > Metadata Proxy
Get Metadata Proxy status with given proxy id and attached logical switch.
GET /api/v1/md-proxies/<proxy-id>/<logical-switch-id>/status (Deprecated)
Management Plane API > Networking > VPN > IPSEC > DPD Profiles
Get IPSec dead peer detection (DPD) profile list result
GET /api/v1/vpn/ipsec/dpd-profiles (Deprecated)
Management Plane API > Networking > VPN > IPSEC > DPD Profiles
Create dead peer detection (DPD) profile
POST /api/v1/vpn/ipsec/dpd-profiles (Deprecated)
Management Plane API > Networking > VPN > IPSEC > DPD Profiles
Delete dead peer detection (DPD) profile
DELETE /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > DPD Profiles
Get IPSec dead peer detection (DPD) profile
GET /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > DPD Profiles
Edit IPSec dead peer detection (DPD) profile
PUT /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > IKE Profiles
List IKE profiles
GET /api/v1/vpn/ipsec/ike-profiles (Deprecated)
Management Plane API > Networking > VPN > IPSEC > IKE Profiles
Create custom internet key exchange (IKE) Profile
POST /api/v1/vpn/ipsec/ike-profiles (Deprecated)
Management Plane API > Networking > VPN > IPSEC > IKE Profiles
Delete custom IKE Profile
DELETE /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > IKE Profiles
Get IKE Profile
GET /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > IKE Profiles
Edit custom IKE Profile
PUT /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Get IPSec local endpoint list result
GET /api/v1/vpn/ipsec/local-endpoints (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Create custom local endpoint
POST /api/v1/vpn/ipsec/local-endpoints (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Delete custom IPSec local endpoint
DELETE /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Get custom IPSec local endpoint
GET /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Edit custom IPSec local endpoint
PUT /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Get IPSecVPNPeerEndpoint List Result
GET /api/v1/vpn/ipsec/peer-endpoints (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Create custom peer endpoint
POST /api/v1/vpn/ipsec/peer-endpoints (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Delete custom IPSec VPN peer endpoint
DELETE /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Get IPSec VPN peer endpoint
GET /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Get IPSec VPN peer endpoint with PSK
GET /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>?action=show-sensitive-data (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Peer Endpoints
Edit custom IPSecPeerEndpoint
PUT /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Services
Get IPSec VPN service list result
GET /api/v1/vpn/ipsec/services (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Services
Create VPN service
POST /api/v1/vpn/ipsec/services (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Services
Delete IPSec VPN service
DELETE /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Services
Get IPSec VPN service
GET /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Services
Edit IPSec VPN service
PUT /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Get IPSec VPN session list result
GET /api/v1/vpn/ipsec/sessions (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Create new VPN session
POST /api/v1/vpn/ipsec/sessions (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Delete IPSec VPN session
DELETE /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Fetch IPSec VPN session
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Edit IPSec VPN session
PUT /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Get VPN configuration for the peer site
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/peer-config (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Get the Realized State of a IPSec VPN Session
GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/state (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Sessions
Reset IPSec VPN session statistics
POST /api/v1/vpn/ipsec/sessions/<sessionid>/statistics?action=reset
Management Plane API > Networking > VPN > IPSEC > Tunnel Profiles
Get IPSecTunnelProfile List Result
GET /api/v1/vpn/ipsec/tunnel-profiles (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Tunnel Profiles
Create custom IPSec tunnel profile
POST /api/v1/vpn/ipsec/tunnel-profiles (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Tunnel Profiles
Delete custom IPSecTunnelProfile
DELETE /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Tunnel Profiles
Get IPSec tunnel profile
GET /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id> (Deprecated)
Management Plane API > Networking > VPN > IPSEC > Tunnel Profiles
Edit custom IPSecTunnelProfile
PUT /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id> (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Services
Get all L2VPN services
GET /api/v1/vpn/l2vpn/services (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Services
Create L2VPN service
POST /api/v1/vpn/l2vpn/services (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Services
Delete a L2VPN service
DELETE /api/v1/vpn/l2vpn/services/<l2vpn-service-id> (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Services
Get L2VPN service
GET /api/v1/vpn/l2vpn/services/<l2vpn-service-id> (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Services
Edit a L2VPN service
PUT /api/v1/vpn/l2vpn/services/<l2vpn-service-id> (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Sessions
Get all L2VPN sessions
GET /api/v1/vpn/l2vpn/sessions (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Sessions
Create L2VPN session
POST /api/v1/vpn/l2vpn/sessions (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Sessions
Delete a L2VPN session
DELETE /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id> (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Sessions
Get a L2VPN session
GET /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id> (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Sessions
Edit a L2VPN session
PUT /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id> (Deprecated)
Management Plane API > Networking > VPN > L2VPN > Sessions
Get peer codes for the L2VpnSession
GET /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id>/peer-codes (Deprecated)
Management Plane API > Networking > VPN > Statistics > IKE Service
Cumulative statistics for one IKE service instance
GET /api/v1/vpn/services/<service-id>/summary (Deprecated)
Management Plane API > Networking > VPN > Statistics > IKE Sessions Status
Get IPSec VPN IKE session status
GET /api/v1/vpn/ipsec/sessions/<session-id>/status (Deprecated)
Management Plane API > Networking > VPN > Statistics > IPSEC Reset Sessions Statistics
Reset the statistics of the given VPN session
POST /api/v1/vpn/ipsec/sessions/<session-id>/statistics?action=reset (Deprecated)
Management Plane API > Networking > VPN > Statistics > IPSEC Sessions Statistics
Get IPSec VPN session statistics
GET /api/v1/vpn/ipsec/sessions/<session-id>/statistics (Deprecated)
Management Plane API > Networking > VPN > Statistics > IPSEC Sessions Summary
VPN session summary
GET /api/v1/vpn/ipsec/sessions/summary (Deprecated)
Management Plane API > Networking > VPN > Statistics > L2VPN Remote MACS
Get L2VPN session remote mac for logical switch
GET /api/v1/vpn/l2vpn/sessions/<session-id>/remote-mac (Deprecated)
Management Plane API > Networking > VPN > Statistics > L2VPN Session Statistics
Get L2VPN session statistics
GET /api/v1/vpn/l2vpn/sessions/<session-id>/statistics (Deprecated)
Management Plane API > Networking > VPN > Statistics > L2VPN Session Status
Get L2VPN session status
GET /api/v1/vpn/l2vpn/sessions/<session-id>/status (Deprecated)
Management Plane API > Networking > VPN > Statistics > L2VPN Sessions Summary
Get status summary of all existing L2VPN sessions.
GET /api/v1/vpn/l2vpn/sessions/summary (Deprecated)
Management Plane API > Normalization
Get normalizations based on the query parameters
GET /api/v1/normalizations (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
List all Identity firewall compute collections
GET /api/v1/idfw/idfw-compute-collections (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
Delete IDFW compute collection.
DELETE /api/v1/idfw/idfw-compute-collections/<cc-ext-id> (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
Get IDFW compute collection.
GET /api/v1/idfw/idfw-compute-collections/<cc-ext-id> (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
Update IDFW compute collection
PUT /api/v1/idfw/idfw-compute-collections/<cc-ext-id> (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
Get Identity Firewall master switch enabled/disabled
GET /api/v1/idfw/master-switch-setting (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
Update IDFW master switch setting enabled/disabled
PUT /api/v1/idfw/master-switch-setting (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
Get Standalone hosts switch enabled/disabled
GET /api/v1/idfw/standalone-host-switch-setting (Deprecated)
Management Plane API > Security > Identity Firewall > Configuration
Update IDFW master switch setting enabled/disabled
PUT /api/v1/idfw/standalone-host-switch-setting (Deprecated)
Management Plane API > Security > Identity Firewall > Monitoring
List all transport node and statuses based on idfw enabled ComputeCollection ID.
GET /api/v1/idfw/compute-collections/<cc-ext-id>/transport-nodes/status (Deprecated)
Management Plane API > Security > Identity Firewall > Monitoring
Get list of compute collections and status.
GET /api/v1/idfw/compute-collections/<compute-collection-ext-id>/status (Deprecated)
Management Plane API > Security > Identity Firewall > Monitoring
List all IDFW enabled ComputeCollection statuses.
GET /api/v1/idfw/compute-collections/status (Deprecated)
Management Plane API > Security > Identity Firewall > Monitoring
List all VM and statuses based on transport node ID of idfw enabled compute collection.
GET /api/v1/idfw/transport-nodes/<transport-node-id>/vms/status (Deprecated)
Management Plane API > Security > Identity Firewall > Realization Data
Get all IDFW NSGroup VM details for a given NSGroup
GET /api/v1/idfw/nsgroup-vm-details/<group-id> (Deprecated)
Management Plane API > Security > Identity Firewall > Realization Data
Get IDFW system statistics data
GET /api/v1/idfw/system-stats (Deprecated)
Management Plane API > Security > Identity Firewall > Realization Data
Get user session data
GET /api/v1/idfw/user-session-data (Deprecated)
Management Plane API > Security > Identity Firewall > Realization Data
Get IDFW user login events for a given user
GET /api/v1/idfw/user-stats/<user-id> (Deprecated)
Management Plane API > Security > Identity Firewall > Realization Data
Get IDFW user login events for a given VM
GET /api/v1/idfw/vm-stats/<vm-ext-id> (Deprecated)
Management Plane API > Security > Intrusion Services > Dashboard
Get the list of the users affected for that signature
POST /api/v1/intrusion-services/affected-users (Deprecated)
Management Plane API > Security > Intrusion Services > Dashboard
Get the list of the VMs affected for that signature
POST /api/v1/intrusion-services/affected-vms (Deprecated)
Management Plane API > Security > Intrusion Services > Dashboard
Get the list of the IDS events that are detected, grouped by signature id.
POST /api/v1/intrusion-services/ids-events (Deprecated)
Management Plane API > Security > Intrusion Services > Dashboard
Get the summary of the intrusions that were detected.
POST /api/v1/intrusion-services/ids-summary (Deprecated)
Management Plane API > Security > Intrusion Services > IDS Profiles
Get IDSProfile
GET /api/v1/intrusion-services/profiles/<ids-profile-id> (Deprecated)
Management Plane API > Security > Service Configuration
List service configs
GET /api/v1/service-configs
Management Plane API > Security > Service Configuration
Create service config
POST /api/v1/service-configs
Management Plane API > Security > Service Configuration
Delete Service Config
DELETE /api/v1/service-configs/<config-set-id>
Management Plane API > Security > Service Configuration
Read Service Config
GET /api/v1/service-configs/<config-set-id>
Management Plane API > Security > Service Configuration
Update service config
PUT /api/v1/service-configs/<config-set-id>
Management Plane API > Security > Service Configuration
Creates/Updates service configs sent in batch request
POST /api/v1/service-configs/batch
Management Plane API > Security > Service Configuration
Get Effective Profiles for an Entity
GET /api/v1/service-configs/effective-profiles
Management Plane API > Security > Services > Firewall
Get list of entities in exclude list.
GET /api/v1/firewall/excludelist (Deprecated)
Management Plane API > Security > Services > Firewall
Check if the object a member of the exclude list
POST /api/v1/firewall/excludelist?action=check_if_exists
Management Plane API > Security > Services > Firewall
Remove an existing object from the exclude list.
POST /api/v1/firewall/excludelist?action=remove_member (Deprecated)
Management Plane API > Security > Services > Firewall
Add a new object in the exclude list.
POST /api/v1/firewall/excludelist?action=add_member (Deprecated)
Management Plane API > Security > Services > Firewall
Modify exclude list.
PUT /api/v1/firewall/excludelist (Deprecated)
Management Plane API > Security > Services > Firewall
Get firewall profiles available.
GET /api/v1/firewall/profiles (Deprecated)
Management Plane API > Security > Services > Firewall
Create a firewall profile.
POST /api/v1/firewall/profiles (Deprecated)
Management Plane API > Security > Services > Firewall
Delete a firewall profile.
DELETE /api/v1/firewall/profiles/<profile-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Get all firewall session timer profiles.
GET /api/v1/firewall/profiles/<profile-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Update a firewall profile.
PUT /api/v1/firewall/profiles/<profile-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Read an Existing Rule
GET /api/v1/firewall/rules/<rule-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Get the Realized State of a Firewall Rule
GET /api/v1/firewall/rules/<rule-id>/state (Deprecated)
Management Plane API > Security > Services > Firewall
List All Firewall Sections
GET /api/v1/firewall/sections (Deprecated)
Management Plane API > Security > Services > Firewall
Create a Section with Rules.
POST /api/v1/firewall/sections?action=create_with_rules (Deprecated)
Management Plane API > Security > Services > Firewall
Create a New Empty Section
POST /api/v1/firewall/sections (Deprecated)
Management Plane API > Security > Services > Firewall
Delete an Existing Section and Its Associated Rules
DELETE /api/v1/firewall/sections/<section-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Get an Existing Section
GET /api/v1/firewall/sections/<section-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Unlock a section
POST /api/v1/firewall/sections/<section-id>?action=unlock (Deprecated)
Management Plane API > Security > Services > Firewall
Get an Existing Section, Including Rules
POST /api/v1/firewall/sections/<section-id>?action=list_with_rules (Deprecated)
Management Plane API > Security > Services > Firewall
Update an Existing Section, Including Its Rules
POST /api/v1/firewall/sections/<section-id>?action=update_with_rules (Deprecated)
Management Plane API > Security > Services > Firewall
Update an Existing Section, Including Its Position
POST /api/v1/firewall/sections/<section-id>?action=revise (Deprecated)
Management Plane API > Security > Services > Firewall
Update an Existing Section with Rules
POST /api/v1/firewall/sections/<section-id>?action=revise_with_rules (Deprecated)
Management Plane API > Security > Services > Firewall
Lock a section
POST /api/v1/firewall/sections/<section-id>?action=lock (Deprecated)
Management Plane API > Security > Services > Firewall
Update an Existing Section
PUT /api/v1/firewall/sections/<section-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Get All the Rules for a Section
GET /api/v1/firewall/sections/<section-id>/rules (Deprecated)
Management Plane API > Security > Services > Firewall
Add Multiple Rules in a Section
POST /api/v1/firewall/sections/<section-id>/rules?action=create_multiple (Deprecated)
Management Plane API > Security > Services > Firewall
Add a Single Rule in a Section
POST /api/v1/firewall/sections/<section-id>/rules (Deprecated)
Management Plane API > Security > Services > Firewall
Delete an Existing Rule
DELETE /api/v1/firewall/sections/<section-id>/rules/<rule-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Read an Existing Rule
GET /api/v1/firewall/sections/<section-id>/rules/<rule-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Update an Existing Rule and Reorder the Rule
POST /api/v1/firewall/sections/<section-id>/rules/<rule-id>?action=revise (Deprecated)
Management Plane API > Security > Services > Firewall
Update an Existing Rule
PUT /api/v1/firewall/sections/<section-id>/rules/<rule-id> (Deprecated)
Management Plane API > Security > Services > Firewall
Get Firewall rule level statistics
GET /api/v1/firewall/sections/<section-id>/rules/<rule-id>/stats (Deprecated)
Management Plane API > Security > Services > Firewall
Get Firewall section level statistics section
GET /api/v1/firewall/sections/<section-id>/rules/stats (Deprecated)
Management Plane API > Security > Services > Firewall
Get the Realized State of a Firewall Section
GET /api/v1/firewall/sections/<section-id>/state (Deprecated)
Management Plane API > Security > Services > Firewall
Get the summary of sections in the firewall configuration.
GET /api/v1/firewall/sections/summary
Management Plane API > Security > Services > Firewall
Reset firewall rule statistics
POST /api/v1/firewall/stats?action=reset (Deprecated)
Management Plane API > Security > Services > Firewall
List all firewall status for supported contexts
GET /api/v1/firewall/status (Deprecated)
Management Plane API > Security > Services > Firewall
Get firewall global status for dfw context
GET /api/v1/firewall/status/<context-type> (Deprecated)
Management Plane API > Security > Services > Firewall
Update global firewall status for dfw context
PUT /api/v1/firewall/status/<context-type> (Deprecated)
Management Plane API > Security > Services > Firewall
Get firewall status for target resource in dfw context
GET /api/v1/firewall/status/<context-type>/<id> (Deprecated)
Management Plane API > Security > Services > Firewall
Enable firewall on target resource in dfw context
POST /api/v1/firewall/status/<context-type>/<id>?action=enable_firewall (Deprecated)
Management Plane API > Security > Services > Firewall
Disable firewall on target resource in dfw context
POST /api/v1/firewall/status/<context-type>/<id>?action=disable_firewall (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get list of members in exclude list
GET /api/v1/serviceinsertion/excludelist (Deprecated)
Management Plane API > Security > Services > Service Insertion
Add a new member in the exclude list
POST /api/v1/serviceinsertion/excludelist?action=add_member (Deprecated)
Management Plane API > Security > Services > Service Insertion
Remove an existing object from the exclude list
POST /api/v1/serviceinsertion/excludelist?action=remove_member (Deprecated)
Management Plane API > Security > Services > Service Insertion
Modify exclude list
PUT /api/v1/serviceinsertion/excludelist (Deprecated)
Management Plane API > Security > Services > Service Insertion
List All Service Insertion Sections
GET /api/v1/serviceinsertion/sections (Deprecated)
Management Plane API > Security > Services > Service Insertion
Create a New Empty Section
POST /api/v1/serviceinsertion/sections (Deprecated)
Management Plane API > Security > Services > Service Insertion
Create a Section with Rules
POST /api/v1/serviceinsertion/sections?action=create_with_rules (Deprecated)
Management Plane API > Security > Services > Service Insertion
Delete an Existing Section and Its Associated Rules
DELETE /api/v1/serviceinsertion/sections/<section-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get an Existing Section
GET /api/v1/serviceinsertion/sections/<section-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update an Existing Section, Including Its Rules
POST /api/v1/serviceinsertion/sections/<section-id>?action=update_with_rules (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update an Existing Section with Rules
POST /api/v1/serviceinsertion/sections/<section-id>?action=revise_with_rules (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update an Existing Section, Including Its Position
POST /api/v1/serviceinsertion/sections/<section-id>?action=revise (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get an Existing Section, Including Rules
POST /api/v1/serviceinsertion/sections/<section-id>?action=list_with_rules (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update an Existing Section
PUT /api/v1/serviceinsertion/sections/<section-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get All the Rules for a Section
GET /api/v1/serviceinsertion/sections/<section-id>/rules (Deprecated)
Management Plane API > Security > Services > Service Insertion
Add Multiple Rules in a Section
POST /api/v1/serviceinsertion/sections/<section-id>/rules?action=create_multiple (Deprecated)
Management Plane API > Security > Services > Service Insertion
Add a Single Rule in a Section
POST /api/v1/serviceinsertion/sections/<section-id>/rules (Deprecated)
Management Plane API > Security > Services > Service Insertion
Delete an Existing Rule
DELETE /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Read an Existing Rule
GET /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update an Existing Rule and Reorder the Rule
POST /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id>?action=revise (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update an Existing Rule
PUT /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get all service attachments.
GET /api/v1/serviceinsertion/service-attachments (Deprecated)
Management Plane API > Security > Services > Service Insertion
Add a Service Attachment.
POST /api/v1/serviceinsertion/service-attachments (Deprecated)
Management Plane API > Security > Services > Service Insertion
Delete an existing service attachment
DELETE /api/v1/serviceinsertion/service-attachments/<service-attachment-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get a particular service attachment.
GET /api/v1/serviceinsertion/service-attachments/<service-attachment-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update an existing service attachment.
PUT /api/v1/serviceinsertion/service-attachments/<service-attachment-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
List all ServiceChains.
GET /api/v1/serviceinsertion/service-chains (Deprecated)
Management Plane API > Security > Services > Service Insertion
Add Service Chain
POST /api/v1/serviceinsertion/service-chains (Deprecated)
Management Plane API > Security > Services > Service Insertion
Delete a Service Chain.
DELETE /api/v1/serviceinsertion/service-chains/<service-chain-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get a particular service chain.
GET /api/v1/serviceinsertion/service-chains/<service-chain-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
List all service paths
GET /api/v1/serviceinsertion/service-chains/<service-chain-id>/service-paths (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get all Service-Instances present in system
GET /api/v1/serviceinsertion/service-instances
Management Plane API > Security > Services > Service Insertion
List service managers
GET /api/v1/serviceinsertion/service-managers
Management Plane API > Security > Services > Service Insertion
Register service manager
POST /api/v1/serviceinsertion/service-managers
Management Plane API > Security > Services > Service Insertion
Delete service manager
DELETE /api/v1/serviceinsertion/service-managers/<service-manager-id>
Management Plane API > Security > Services > Service Insertion
Get service manager
GET /api/v1/serviceinsertion/service-managers/<service-manager-id>
Management Plane API > Security > Services > Service Insertion
Update service manager
PUT /api/v1/serviceinsertion/service-managers/<service-manager-id>
Management Plane API > Security > Services > Service Insertion
List all Service-Insertion Services.
GET /api/v1/serviceinsertion/services
Management Plane API > Security > Services > Service Insertion
Create a Service-Insertion Service
POST /api/v1/serviceinsertion/services
Management Plane API > Security > Services > Service Insertion
Delete an existing Service and the Service-Instance associated with it.
DELETE /api/v1/serviceinsertion/services/<service-id>
Management Plane API > Security > Services > Service Insertion
Get an existing Service
GET /api/v1/serviceinsertion/services/<service-id>
Management Plane API > Security > Services > Service Insertion
Update an existing Service
PUT /api/v1/serviceinsertion/services/<service-id>
Management Plane API > Security > Services > Service Insertion
Get all service deployments for the given service id
GET /api/v1/serviceinsertion/services/<service-id>/service-deployments
Management Plane API > Security > Services > Service Insertion
Deploys a particular service
POST /api/v1/serviceinsertion/services/<service-id>/service-deployments
Management Plane API > Security > Services > Service Insertion
Remove service deployment
DELETE /api/v1/serviceinsertion/services/<service-id>/service-deployments/<service-deployment-id>
Management Plane API > Security > Services > Service Insertion
Get a particular service deployment.
GET /api/v1/serviceinsertion/services/<service-id>/service-deployments/<service-deployment-id>
Management Plane API > Security > Services > Service Insertion
Upgrade all VMs part of this service deployment to new Spec OVF.
POST /api/v1/serviceinsertion/services/<service-id>/service-deployments/<service-deployment-id>?action=upgrade
Management Plane API > Security > Services > Service Insertion
Update an existing Service Deployment.
PUT /api/v1/serviceinsertion/services/<service-id>/service-deployments/<service-deployment-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get Service-Deployment state for Service.
GET /api/v1/serviceinsertion/services/<service-id>/service-deployments/<service-deployment-id>/state
Management Plane API > Security > Services > Service Insertion
Get a particular service deployment status.
GET /api/v1/serviceinsertion/services/<service-id>/service-deployments/<service-deployment-id>/status
Management Plane API > Security > Services > Service Insertion
Get all Service-Instances for Service.
GET /api/v1/serviceinsertion/services/<service-id>/service-instances
Management Plane API > Security > Services > Service Insertion
Add a Service Instance for a specified Service.
POST /api/v1/serviceinsertion/services/<service-id>/service-instances
Management Plane API > Security > Services > Service Insertion
Delete an existing Service-Instance
DELETE /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get Service-Instance for Service.
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>
Management Plane API > Security > Services > Service Insertion
Update an existing Service-Instance.
PUT /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get NSgroups for a given ServiceInstance.
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/group-associations
Management Plane API > Security > Services > Service Insertion
List all InstanceEndpoints of a Service Instance.
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-endpoints
Management Plane API > Security > Services > Service Insertion
Add an InstanceEndpoint for a Service Instance
POST /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-endpoints (Deprecated)
Management Plane API > Security > Services > Service Insertion
Delete a particular InstanceEndpoint.
DELETE /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-endpoints/<instance-endpoint-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get a particular instance endpoint for a service instance.
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-endpoints/<instance-endpoint-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Returns list of instance runtimes of service VM being deployed
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes
Management Plane API > Security > Services > Service Insertion
Deploy and set up service VMs either as standalone or HA
POST /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes?action=deploy (Deprecated)
Management Plane API > Security > Services > Service Insertion
Remove service VMs either as standalone or HA
POST /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes?action=delete (Deprecated)
Management Plane API > Security > Services > Service Insertion
Upgrade service VMs using newer version of OVF
POST /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes?action=upgrade (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update maintenance mode or runtime state of a service VM
POST /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes/<instance-runtime-id>
Management Plane API > Security > Services > Service Insertion
Get statistics for a given interface identified by the interface index
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes/<instance-runtime-id>/interfaces/<interface_index>/statistics (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get operational status for an interface
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes/<instance-runtime-id>/interfaces/<interface_index>/status
Management Plane API > Security > Services > Service Insertion
Get Service-Instance state for Service.
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/state
Management Plane API > Security > Services > Service Insertion
Get Service-Instance status for Service.
GET /api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/status
Management Plane API > Security > Services > Service Insertion
List all Service Profiles of a Service.
GET /api/v1/serviceinsertion/services/<service-id>/service-profiles (Deprecated)
Management Plane API > Security > Services > Service Insertion
Add ServiceProfile for a given Service.
POST /api/v1/serviceinsertion/services/<service-id>/service-profiles (Deprecated)
Management Plane API > Security > Services > Service Insertion
Delete a particular ServiceProfile.
DELETE /api/v1/serviceinsertion/services/<service-id>/service-profiles/<service-profile-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get a particular ServiceProfile for a Service.
GET /api/v1/serviceinsertion/services/<service-id>/service-profiles/<service-profile-id> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get NSgroups for a given ServiceProfile.
GET /api/v1/serviceinsertion/services/<service-id>/service-profiles/<service-profile-id>/nsgroups (Deprecated)
Management Plane API > Security > Services > Service Insertion
List all ServiceChainMappings.
GET /api/v1/serviceinsertion/services/<service-id>/service-profiles/<service-profile-id>/service-chain-mappings (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get Solution Config Information associated with a given service.
GET /api/v1/serviceinsertion/services/<service-id>/solution-configs
Management Plane API > Security > Services > Service Insertion
Add Solution Config for a given Service
POST /api/v1/serviceinsertion/services/<service-id>/solution-configs
Management Plane API > Security > Services > Service Insertion
Deletes solution config information.
DELETE /api/v1/serviceinsertion/services/<service-id>/solution-configs/<solution-config-id>
Management Plane API > Security > Services > Service Insertion
Get Solution Config Information for a given solution config id.
GET /api/v1/serviceinsertion/services/<service-id>/solution-configs/<solution-config-id>
Management Plane API > Security > Services > Service Insertion
Updates Solution Config for a given Service
PUT /api/v1/serviceinsertion/services/<service-id>/solution-configs/<solution-config-id>
Management Plane API > Security > Services > Service Insertion
Deletes extended solution config information.
DELETE /api/v1/serviceinsertion/services/<service-id>/solution-configs/<solution-config-id>/extended-solution-config
Management Plane API > Security > Services > Service Insertion
Get extended solution Config Information for a given solution config id.
GET /api/v1/serviceinsertion/services/<service-id>/solution-configs/<solution-config-id>/extended-solution-config
Management Plane API > Security > Services > Service Insertion
Add Extended solution Config for a given Service
POST /api/v1/serviceinsertion/services/<service-id>/solution-configs/<solution-config-id>/extended-solution-config
Management Plane API > Security > Services > Service Insertion
Updates extended solution Config for a given Service
PUT /api/v1/serviceinsertion/services/<service-id>/solution-configs/<solution-config-id>/extended-solution-config
Management Plane API > Security > Services > Service Insertion
List all VendorTemplates of a Service.
GET /api/v1/serviceinsertion/services/<service-id>/vendor-templates
Management Plane API > Security > Services > Service Insertion
Add Vendor Template for a given Service
POST /api/v1/serviceinsertion/services/<service-id>/vendor-templates
Management Plane API > Security > Services > Service Insertion
Delete a particular vendor tempalte.
DELETE /api/v1/serviceinsertion/services/<service-id>/vendor-templates/<vendor-template-id>
Management Plane API > Security > Services > Service Insertion
Get a particular vendor template for a given service.
GET /api/v1/serviceinsertion/services/<service-id>/vendor-templates/<vendor-template-id>
Management Plane API > Security > Services > Service Insertion
Resolve 'source node id' value to source entities.
GET /api/v1/serviceinsertion/source-entities
Management Plane API > Security > Services > Service Insertion
List all service insertion status for supported contexts
GET /api/v1/serviceinsertion/status (Deprecated)
Management Plane API > Security > Services > Service Insertion
Get ServiceInsertion global status for a context
GET /api/v1/serviceinsertion/status/<context-type> (Deprecated)
Management Plane API > Security > Services > Service Insertion
Update global ServiceInsertion status for a context
PUT /api/v1/serviceinsertion/status/<context-type> (Deprecated)
Management Plane API > Services > DHCP
Get specific leases of a given dhcp server
GET /api/v1/dhcp/servers/<server-id>/leases (Deprecated)
Management Plane API > Services > DHCP
Get DHCP statistics with given dhcp server id
GET /api/v1/dhcp/servers/<server-id>/statistics (Deprecated)
Management Plane API > Services > DNS
Get statistics of given dns forwarder
GET /api/v1/dns/forwarders/<forwarder-id>/statistics (Deprecated)
Management Plane API > Services > Metadata Proxy
Get Metadata Proxy statistics with given proxy id
GET /api/v1/md-proxies/<proxy-id>/statistics (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Healthcheck
List manual health checks
GET /api/v1/manual-health-checks
Management Plane API > Troubleshooting And Monitoring > Healthcheck
Create a new manual health check request
POST /api/v1/manual-health-checks
Management Plane API > Troubleshooting And Monitoring > Healthcheck
Delete an existing manual health check
DELETE /api/v1/manual-health-checks/<manual-health-check-id>
Management Plane API > Troubleshooting And Monitoring > Healthcheck
Get an existing manual health check
GET /api/v1/manual-health-checks/<manual-health-check-id>
Management Plane API > Troubleshooting And Monitoring > IPFIX
List IPFIX Collector Profies
GET /api/v1/ipfix-collector-profiles
Management Plane API > Troubleshooting And Monitoring > IPFIX
Create a new IPFIX collector profile
POST /api/v1/ipfix-collector-profiles
Management Plane API > Troubleshooting And Monitoring > IPFIX
Delete an existing IPFIX collector profile
DELETE /api/v1/ipfix-collector-profiles/<ipfix-collector-profile-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Get an existing IPFIX collector profile
GET /api/v1/ipfix-collector-profiles/<ipfix-collector-profile-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Update an existing IPFIX collector profile
PUT /api/v1/ipfix-collector-profiles/<ipfix-collector-profile-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
List IPFIX Profies
GET /api/v1/ipfix-profiles
Management Plane API > Troubleshooting And Monitoring > IPFIX
Create a new IPFIX profile
POST /api/v1/ipfix-profiles (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Delete an existing IPFIX profile
DELETE /api/v1/ipfix-profiles/<ipfix-profile-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Get an existing IPFIX profile
GET /api/v1/ipfix-profiles/<ipfix-profile-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Update an existing IPFIX profile
PUT /api/v1/ipfix-profiles/<ipfix-profile-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
List IPFIX collector configurations
GET /api/v1/ipfix/collectorconfigs
Management Plane API > Troubleshooting And Monitoring > IPFIX
Create a new IPFIX collector configuration
POST /api/v1/ipfix/collectorconfigs (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Delete an existing IPFIX collector configuration
DELETE /api/v1/ipfix/collectorconfigs/<collector-config-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Get an existing IPFIX collector configuration
GET /api/v1/ipfix/collectorconfigs/<collector-config-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Update an existing IPFIX collector configuration
PUT /api/v1/ipfix/collectorconfigs/<collector-config-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
List IPFIX configuration
GET /api/v1/ipfix/configs
Management Plane API > Troubleshooting And Monitoring > IPFIX
Create a new IPFIX configuration
POST /api/v1/ipfix/configs (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Delete an existing IPFIX configuration
DELETE /api/v1/ipfix/configs/<config-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Get an existing IPFIX configuration
GET /api/v1/ipfix/configs/<config-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > IPFIX
Update an existing IPFIX configuration
PUT /api/v1/ipfix/configs/<config-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Livetrace
List all livetrace sessions
GET /api/v1/livetraces (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Livetrace
Create a livetrace session
POST /api/v1/livetraces (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Livetrace
Delete a livetrace session
DELETE /api/v1/livetraces/<livetrace-session-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Livetrace
Get the status of a livetrace session
GET /api/v1/livetraces/<livetrace-session-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Livetrace
Get forward packet capture file proxy
GET /api/v1/livetraces/<livetrace-session-id>/proxy/forward/capturefile
Management Plane API > Troubleshooting And Monitoring > Livetrace
Get reverse packet capture file proxy
GET /api/v1/livetraces/<livetrace-session-id>/proxy/reverse/capturefile
Management Plane API > Troubleshooting And Monitoring > Livetrace
Get the result of a livetrace session
GET /api/v1/livetraces/<livetrace-session-id>/results (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Create an new packet capture session
POST /api/v1/pktcap/session
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Get the status of packet capture session
GET /api/v1/pktcap/session/<session-id>
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Restart the packet capture session
POST /api/v1/pktcap/session/<session-id>?action=restart
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Delete the packet capture session by session id.
POST /api/v1/pktcap/session/<session-id>?action=delete
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Terminate the packet capture session by session id
POST /api/v1/pktcap/session/<session-id>?action=terminate
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Get packet capture file
GET /api/v1/pktcap/session/<session-id>/capturefile
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Get the information of all packet capture sessions
GET /api/v1/pktcap/sessions
Management Plane API > Troubleshooting And Monitoring > Packet Capture
Delete all the packet capture sessions
POST /api/v1/pktcap/sessions?action=delete
Management Plane API > Troubleshooting And Monitoring > Port Connection
Get networking entities between two logical ports with VIF attachment
GET /api/v1/logical-ports/<lport-id>/forwarding-path
Management Plane API > Troubleshooting And Monitoring > Port Mirroring
List all mirror sessions
GET /api/v1/mirror-sessions
Management Plane API > Troubleshooting And Monitoring > Port Mirroring
Create a mirror session
POST /api/v1/mirror-sessions (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Port Mirroring
Delete the mirror session
DELETE /api/v1/mirror-sessions/<mirror-session-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Port Mirroring
Get the mirror session
GET /api/v1/mirror-sessions/<mirror-session-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Port Mirroring
Verify whether the mirror session is still valid
POST /api/v1/mirror-sessions/<mirror-session-id>?action=verify
Management Plane API > Troubleshooting And Monitoring > Port Mirroring
Update the mirror session
PUT /api/v1/mirror-sessions/<mirror-session-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Port Mirroring
Get the mirror stack status on given remote L3 mirror session
GET /api/v1/mirror-sessions/<mirror-session-id>/mirror-stack-status
Management Plane API > Troubleshooting And Monitoring > Traceflow
List all Traceflow rounds
GET /api/v1/traceflows
Management Plane API > Troubleshooting And Monitoring > Traceflow
Initiate a Traceflow Operation on the Specified Port
POST /api/v1/traceflows (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Traceflow
Delete the Traceflow round
DELETE /api/v1/traceflows/<traceflow-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Traceflow
Get the Traceflow round status and result summary
GET /api/v1/traceflows/<traceflow-id> (Deprecated)
Management Plane API > Troubleshooting And Monitoring > Traceflow
Get observations for the Traceflow round
GET /api/v1/traceflows/<traceflow-id>/observations (Deprecated)
NSX Application Platform > Deployment > Bundle > Status
Get progress status of kubernetes tools bundle upload
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/tools/upload/status/<bundle-id>
NSX Application Platform > Deployment > Platform > Config
Get NSX Application Platform deployment configuration
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/platform
NSX Application Platform > Deployment > Platform > Config
Update platform configuration
PATCH /policy/api/v1/infra/sites/<site-id>/napp/deployment/platform
NSX Application Platform > Deployment > Platform > Form Factors
Get available deployment form factors for NSX Application Platform
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/platform/form-factors
NSX Application Platform > Deployment > Platform > Status
Run pre/post checks for NSX Application Platform
PUT /policy/api/v1/infra/sites/<site-id>/napp/deployment/platform/checks
NSX Application Platform > Deployment > Platform > Status
Get NSX Application Platform pre/post checks progress status
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/platform/checks/status
NSX Application Platform > Deployment > Platform > Status
Get platform deployment or undeployment progress status
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/platform/status
NSX Application Platform > Deployment > Platform > Storageclass
Get list of Kubernetes storage classes
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/storage-classes
NSX Application Platform > Deployment > Platform > Versions
Get NSX Application Platform versions
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/platform/versions
NSX Application Platform > Deployment > Registry
Get helm repo and docker registry url
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/registry
NSX Application Platform > Deployment > Registry
Update Docker registry and helm repository url.
PUT /policy/api/v1/infra/sites/<site-id>/napp/deployment/registry
NSX Application Platform > Deployment > Registry
Reset helm and docker url to default one
PUT /policy/api/v1/infra/sites/<site-id>/napp/deployment/registry/reset
NSX Application Platform > Deployment > Tools > Bundle > Upload
Upload the Kubernetes tools on NSX Manager via remote URL
POST /policy/api/v1/infra/sites/<site-id>/napp/deployment/tools/upload_from_remote_server
NSX Application Platform > Deployment > Upgrade > Coordinator > Check
Run pre/post checks for NSX Application Platform upgrade-coordinator
PUT /policy/api/v1/infra/sites/<site-id>/napp/deployment/upgrade-coordinator/checks
NSX Application Platform > Deployment > Upgrade > Coordinator > Check > Status
Get NSX Application Platform upgrade-coordinator pre/post checks progress status.
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/upgrade-coordinator/checks/status
NSX Application Platform > Deployment > Upgrade > Coordinator > Versions
Get NSX Application Platform upgrade-coordinator versions
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/upgrade-coordinator/versions
NSX Application Platform > Kubeconfig
Get information about kubeconfig file
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/kubeconfig
NSX Application Platform > Kubeconfig
Upload kubeconfig file
POST /policy/api/v1/infra/sites/<site-id>/napp/deployment/kubeconfig
NSX Application Platform > Kubernetes > Tools
Get information about Kubernetes tools
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/kubernetes-tools
NSX Application Platform > Platform > Host Agent
Get NSX Application Platform Common Agent host configuration
GET /policy/api/v1/infra/napp/common-agent/host-config
NSX Application Platform > Platform > Host Agent
Patch NSX Application Platform Common Agent host configuration
PATCH /policy/api/v1/infra/napp/common-agent/host-config
NSX Application Platform > Platform > Host Agent
Reset NSX Application Platform Common Agent host configuration
POST /policy/api/v1/infra/napp/common-agent/host-config?action=reset
NSX Application Platform > Platform > Tools > Bundle > Upload
Upload the Kubernetes tools on NSX Manager via File
POST /policy/api/v1/infra/sites/<site-id>/napp/deployment/tools/upload
NSX Application Platform > Upgrade > Coordinator > Config
Get upgrade coordinator deployment configuration
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/upgrade-coordinator
NSX Application Platform > Upgrade > Coordinator > Config
Update upgrade-coordinator configuration
PATCH /policy/api/v1/infra/sites/<site-id>/napp/deployment/upgrade-coordinator
NSX Application Platform > Upgrade > Coordinator > Status
Get deployment or undeployment progress status
GET /policy/api/v1/infra/sites/<site-id>/napp/deployment/upgrade-coordinator/status
Policy
Get the list of services where the given group is consumed.
GET /policy/api/v1/infra/group-service-associations
GET /policy/api/v1/global-infra/group-service-associations
Policy > Infra > Certificates > CSR
Return All the Generated CSRs
GET /policy/api/v1/infra/csrs
Policy > Infra > Certificates > CSR
Generate a new self-signed certificate
POST /policy/api/v1/infra/csrs?action=self_sign
Policy > Infra > Certificates > CSR
Delete a CSR
DELETE /policy/api/v1/infra/csrs/<csr-id>
Policy > Infra > Certificates > CSR
Show CSR Data for the Given CSR ID
GET /policy/api/v1/infra/csrs/<csr-id>
Policy > Infra > Certificates > CSR
Self-Sign the CSR
POST /policy/api/v1/infra/csrs/<csr-id>?action=self_sign
Policy > Infra > Certificates > CSR
Generate a New Certificate Signing Request
POST /policy/api/v1/infra/csrs/<csr-id>?action=create
Policy > Infra > Certificates > CSR
Import a Certificate Associated with an Approved CSR
POST /policy/api/v1/infra/csrs/<csr-id>?action=import
Policy > Infra > Certificates > CSR
Upload the Certificate PEM File Signed by the CA Associated with a CSR
POST /policy/api/v1/infra/csrs/<csr-id>?action=upload
Policy > Infra > Certificates > CSR
Get CSR PEM File for the Given CSR ID
GET /policy/api/v1/infra/csrs/<csr-id>/pem-file
Policy > Infra > Certificates > Certificates
Returns information about all the CA bundles
GET /policy/api/v1/infra/cabundles
Policy > Infra > Certificates > Certificates
Deletes CA bundle
DELETE /policy/api/v1/infra/cabundles/<cabundle-id>
Policy > Infra > Certificates > Certificates
Returns information about a CA bundle
GET /policy/api/v1/infra/cabundles/<cabundle-id>
Policy > Infra > Certificates > Certificates
Adds or updates a CA bundle
PATCH /policy/api/v1/infra/cabundles/<cabundle-id>
Policy > Infra > Certificates > Certificates
Adds or replaces a CA bundle
POST /policy/api/v1/infra/cabundles/<cabundle-id>
Policy > Infra > Certificates > Certificates
Adds or replaces a CA bundle
PUT /policy/api/v1/infra/cabundles/<cabundle-id>
Policy > Infra > Certificates > Certificates
Downloads a CA bundle
GET /policy/api/v1/infra/cabundles/<cabundle-id>/pem-file
Policy > Infra > Certificates > Certificates
Return All the User-Facing Components' Certificates
GET /policy/api/v1/infra/certificates
GET /policy/api/v1/global-infra/certificates
Policy > Infra > Certificates > Certificates
Delete Certificate for the Given Certificate ID
DELETE /policy/api/v1/infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certificates
Show Certificate Data for the Given Certificate ID
GET /policy/api/v1/infra/certificates/<certificate-id>
GET /policy/api/v1/global-infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certificates
Add a New Certificate
PATCH /policy/api/v1/infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certificates
Add a New Certificate
PUT /policy/api/v1/infra/certificates/<certificate-id>
Policy > Infra > Certificates > Certification Revocation List
Return All Added CRLs
GET /policy/api/v1/infra/crls
GET /policy/api/v1/global-infra/crls
Policy > Infra > Certificates > Certification Revocation List
Delete a CRL
DELETE /policy/api/v1/infra/crls/<crl-id>
Policy > Infra > Certificates > Certification Revocation List
Show CRL Data for the Given CRL id.
GET /policy/api/v1/infra/crls/<crl-id>
GET /policy/api/v1/global-infra/crls/<crl-id>
Policy > Infra > Certificates > Certification Revocation List
Create or patch a Certificate Revocation List
PATCH /policy/api/v1/infra/crls/<crl-id>
Policy > Infra > Certificates > Certification Revocation List
Create a new Certificate Revocation List
POST /policy/api/v1/infra/crls/<crl-id>?action=import
Policy > Infra > Certificates > Certification Revocation List
Upload a new or updated Certificate Revocation List
POST /policy/api/v1/infra/crls/<crl-id>?action=upload
Policy > Infra > Certificates > Certification Revocation List
Create or fully replace a Certificate Revocation List
PUT /policy/api/v1/infra/crls/<crl-id>
Policy > Infra > Constraints
List tenant Constraints.
GET /policy/api/v1/global-infra/constraints
GET /policy/api/v1/infra/constraints
Policy > Infra > Constraints
Delete tenant Constraint.
DELETE /policy/api/v1/infra/constraints/<constraint-id>
Policy > Infra > Constraints
Read tenant Constraint.
GET /policy/api/v1/infra/constraints/<constraint-id>
GET /policy/api/v1/global-infra/constraints/<constraint-id>
Policy > Infra > Constraints
Create or update tenant Constraint
PATCH /policy/api/v1/infra/constraints/<constraint-id>
Policy > Infra > Constraints
Create or update tenant Constraint
PUT /policy/api/v1/infra/constraints/<constraint-id>
Policy > Infra > Deployment Zones
List Deployment Zones for infra
GET /policy/api/v1/infra/deployment-zones (Deprecated)
Policy > Infra > Deployment Zones
Read a DeploymentZone
GET /policy/api/v1/infra/deployment-zones/<deployment-zone-id> (Deprecated)
Policy > Infra > Domains > Domain
List domains for infra
GET /policy/api/v1/global-infra/domains
GET /policy/api/v1/infra/domains
Policy > Infra > Domains > Domain
Delete Domain and all the entities contained by this domain
DELETE /policy/api/v1/infra/domains/<domain-id>
Policy > Infra > Domains > Domain
Read domain
GET /policy/api/v1/infra/domains/<domain-id>
GET /policy/api/v1/global-infra/domains/<domain-id>
Policy > Infra > Domains > Domain
Patch a domain
PATCH /policy/api/v1/infra/domains/<domain-id>
Policy > Infra > Domains > Domain
Create or update a domain
PUT /policy/api/v1/infra/domains/<domain-id>
Policy > Infra > Domains > Domain Deployment Maps
List Domain Deployment maps for infra
GET /policy/api/v1/global-infra/domains/<domain-id>/domain-deployment-maps
GET /policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps
Policy > Infra > Domains > Domain Deployment Maps
Delete Domain Deployment Map
DELETE /policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Domains > Domain Deployment Maps
Read a DomainDeploymentMap
GET /policy/api/v1/global-infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
GET /policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Domains > Domain Deployment Maps
Patch Domain Deployment Map under infra
PATCH /policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Domains > Domain Deployment Maps
Create a new Domain Deployment Map under infra
PUT /policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Policy > Infra > Enforcement Points
List enforcementpoints for infra
GET /policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points (Deprecated)
Policy > Infra > Enforcement Points
Delete EnforcementPoint
DELETE /policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points/<enforcementpoint-id> (Deprecated)
Policy > Infra > Enforcement Points
Read an Enforcement Point
GET /policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points/<enforcementpoint-id> (Deprecated)
Policy > Infra > Enforcement Points
Patch a new Enforcement Point under infra
PATCH /policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points/<enforcementpoint-id> (Deprecated)
Policy > Infra > Enforcement Points
Create/update a new Enforcement Point under infra
PUT /policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points/<enforcementpoint-id> (Deprecated)
Policy > Infra > Enforcement Points
List enforcementpoints under Site
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points
Policy > Infra > Enforcement Points
Full sync EnforcementPoint from Site
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>?action=full-sync
Policy > Infra > Enforcement Points
Delete EnforcementPoint from Site
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
Read an Enforcement Point under Infra/Site
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
Patch a new Enforcement Point under Site
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
Reload an Enforcement Point under Site
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>?action=reload
Policy > Infra > Enforcement Points
Create/update a new Enforcement Point under Site
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>
Policy > Infra > Enforcement Points
List Edge Clusters under an Enforcement Point
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters
Policy > Infra > Enforcement Points
Read a Edge Cluster under an Enforcement Point
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>
Policy > Infra > Enforcement Points
List Edge Nodes under an Enforcement Point, Edge Cluster
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>/edge-nodes
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>/edge-nodes
Policy > Infra > Enforcement Points
Read a Edge Node under an Enforcement Point, Edge Cluster
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>/edge-nodes/<edge-node-id>
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/edge-clusters/<edge-cluster-id>/edge-nodes/<edge-node-id>
Policy > Infra > Hierarchical API
Read infra
GET /policy/api/v1/infra
GET /policy/api/v1/global-infra
Policy > Infra > Hierarchical API
Update the infra including all the nested entities
PATCH /policy/api/v1/infra
PATCH /policy/api/v1/global-infra
Policy > Infra > Hierarchical API
Update the infra object
PUT /policy/api/v1/infra
Policy > Infra > Labels
List labels for infra
GET /policy/api/v1/infra/labels
GET /policy/api/v1/global-infra/labels
Policy > Infra > Labels
Delete PolicyLabel object
DELETE /policy/api/v1/infra/labels/<label-id>
Policy > Infra > Labels
Read lable
GET /policy/api/v1/infra/labels/<label-id>
GET /policy/api/v1/global-infra/labels/<label-id>
Policy > Infra > Labels
Patch an existing label object
PATCH /policy/api/v1/infra/labels/<label-id>
Policy > Infra > Labels
Create or replace label
PUT /policy/api/v1/infra/labels/<label-id>
Policy > Infra > Realized State
List All alarms in the system
GET /policy/api/v1/infra/realized-state/alarms
Policy > Infra > Realized State
List Enforcement Points
GET /policy/api/v1/infra/realized-state/enforcement-points (Experimental)
Policy > Infra > Realized State
Read Enforcement Point
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name> (Experimental)
Policy > Infra > Realized State
List Firewall Sections
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/firewalls/firewall-sections (Experimental) (Deprecated)
Policy > Infra > Realized State
Read Firewall
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/firewalls/firewall-sections/<firewall-section-id> (Experimental) (Deprecated)
Policy > Infra > Realized State
List NS Groups
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/nsgroups (Experimental) (Deprecated)
Policy > Infra > Realized State
Read Group
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/nsgroups/<nsgroup-name> (Experimental) (Deprecated)
Policy > Infra > Realized State
List Security Groups
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/securitygroups (Experimental) (Deprecated)
Policy > Infra > Realized State
Read Group
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/securitygroups/<securitygroup-name> (Experimental) (Deprecated)
Policy > Infra > Realized State
List IPSets
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/ip-sets/ip-sets-nsxt (Experimental) (Deprecated)
Policy > Infra > Realized State
Read IPSet Realized state
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/ip-sets/ip-sets-nsxt/<ip-set-name> (Experimental) (Deprecated)
Policy > Infra > Realized State
List MACSets
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/mac-sets/mac-sets-nsxt (Experimental) (Deprecated)
Policy > Infra > Realized State
Read MACSet Realized state
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/mac-sets/mac-sets-nsxt/<mac-set-name> (Experimental) (Deprecated)
Policy > Infra > Realized State
List Realized NSServices
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/services/nsservices (Experimental) (Deprecated)
Policy > Infra > Realized State
Read NSService
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/services/nsservices/<nsservice-name> (Experimental) (Deprecated)
Policy > Infra > Realized State
Listing of VIFs on the NSX Manager
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/vifs
Policy > Infra > Realized State
Get list of realized objects associated with intent object
GET /policy/api/v1/global-infra/realized-state/realized-entities
GET /policy/api/v1/infra/realized-state/realized-entities
Policy > Infra > Realized State
Get realized entity uniquely identified by realized path
GET /policy/api/v1/infra/realized-state/realized-entity
Policy > Infra > Realized State
Refresh all realized entities associated with the intent-path
POST /policy/api/v1/global-infra/realized-state/realized-entity?action=refresh
POST /policy/api/v1/infra/realized-state/realized-entity?action=refresh
Policy > Infra > Realized State
Get consolidated status of an intent object
GET /policy/api/v1/infra/realized-state/status
GET /policy/api/v1/global-infra/realized-state/status
Policy > Inventory > Containers > Container Applications
Return the list of container application instance
GET /api/v1/fabric/container-application-instances
Policy > Inventory > Containers > Container Applications
Return a container application instance
GET /api/v1/fabric/container-application-instances/<container-application-instance-id>
Policy > Inventory > Containers > Container Applications
Return the List of Container Applications
GET /api/v1/fabric/container-applications
Policy > Inventory > Containers > Container Applications
Return a Container Application within a container project
GET /api/v1/fabric/container-applications/<container-application-id>
Policy > Inventory > Containers > Container Clusters
Return the list of container cluster nodes
GET /api/v1/fabric/container-cluster-nodes
Policy > Inventory > Containers > Container Clusters
Return a container cluster node
GET /api/v1/fabric/container-cluster-nodes/<container-cluster-node-id>
Policy > Inventory > Containers > Container Clusters
Return the List of Container Clusters
GET /api/v1/fabric/container-clusters
Policy > Inventory > Containers > Container Clusters
Return a container cluster
GET /api/v1/fabric/container-clusters/<container-cluster-id>
Policy > Inventory > Containers > Container Clusters
Return the List of Container Ingress Policies
GET /api/v1/fabric/container-ingress-policies
Policy > Inventory > Containers > Container Clusters
Returns an ingress policy spec
GET /api/v1/fabric/container-ingress-policies/<ingress-policy-id>
Policy > Inventory > Containers > Container Clusters
Return the List of Container Network Policies
GET /api/v1/fabric/container-network-policies
Policy > Inventory > Containers > Container Clusters
Return a network policy spec
GET /api/v1/fabric/container-network-policies/<network-policy-id>
Policy > Inventory > Containers > Container Projects
Return the list of container projects
GET /api/v1/fabric/container-projects
Policy > Inventory > Containers > Container Projects
Return a container project
GET /api/v1/fabric/container-projects/<container-project-id>
Policy > Inventory > Groups > Group Members
Get member types for a given Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/member-types
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/member-types
Policy > Inventory > Groups > Group Members
Get consolidated effective IPAddress translated from this group across site
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/consolidated-effective-ip-addresses
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/consolidated-effective-ip-addresses
Policy > Inventory > Groups > Group Members
Get Discovered Port Groups that belong to this Group
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/dvpg
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/dvpg
Policy > Inventory > Groups > Group Members
Get discovered ports that belong to this Group
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/dvports
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/dvports
Policy > Inventory > Groups > Group Members
Get IP addresses that belong to this Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/ip-addresses
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/ip-addresses
Policy > Inventory > Groups > Group Members
Get logical ports that belong to this Group
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/logical-ports
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/logical-ports
Policy > Inventory > Groups > Group Members
Get logical switches that belong to this Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/logical-switches
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/logical-switches
Policy > Inventory > Groups > Group Members
Get pods that belong to this Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/pods
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/pods
Policy > Inventory > Groups > Group Members
Get segment ports that belong to this Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/segment-ports
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/segment-ports
Policy > Inventory > Groups > Group Members
Get segments that belong to this Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/segments
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/segments
Policy > Inventory > Groups > Group Members
Get Virtual Network Interface instances that belong to this Group
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/vifs
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/vifs
Policy > Inventory > Groups > Group Members
Get Virtual machines that belong to this Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/members/virtual-machines
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/members/virtual-machines
Policy > Inventory > Groups > Group Members
Get effective VMs for the Group
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/statistics/virtual-machines (Deprecated)
Policy > Inventory > Groups > Group Members
Get tags used to define conditions inside a Group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/tags
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/tags
Policy > Inventory > Groups > Group Members
Get groups for which the given object is a member
GET /policy/api/v1/infra/group-associations
GET /policy/api/v1/global-infra/group-associations
Policy > Inventory > Groups > Group Members
Get groups for which the given IP address is a member
GET /policy/api/v1/infra/ip-address-group-associations
GET /policy/api/v1/global-infra/ip-address-group-associations
Policy > Inventory > Groups > Group Members
Get groups for which the given pod is a member
GET /policy/api/v1/global-infra/pod-group-associations
GET /policy/api/v1/infra/pod-group-associations
Policy > Inventory > Groups > Group Members
Get groups for which the given VM is a member
GET /policy/api/v1/global-infra/virtual-machine-group-associations
GET /policy/api/v1/infra/virtual-machine-group-associations
Policy > Inventory > Groups > Group Members
Get groups for which the given VIF is a member
GET /policy/api/v1/global-infra/virtual-network-interface-group-associations
GET /policy/api/v1/infra/virtual-network-interface-group-associations
Policy > Inventory > Groups > Groups
List Groups for a domain
GET /policy/api/v1/global-infra/domains/<domain-id>/groups
GET /policy/api/v1/infra/domains/<domain-id>/groups
Policy > Inventory > Groups > Groups
Delete Group
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Read group
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Patch a group
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Create or update a group
PUT /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>
Policy > Inventory > Groups > Groups
Delete Group External ID Expression
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/external-id-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group external ID expression
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/external-id-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove external id based members from/to a Group
POST /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/external-id-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Delete Group IPAddressExpression
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/ip-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group IP Address expression
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/ip-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove IP Addresses from/to a Group
POST /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/ip-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Delete Group MACAddressExpression
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/mac-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group MAC Address expression
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/mac-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove MAC Addresses from/to a Group
POST /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/mac-address-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Delete Group Path Expression
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/path-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Patch a group path expression
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/path-expressions/<expression-id>
Policy > Inventory > Groups > Groups
Add or Remove path based members from/to a Group
POST /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/path-expressions/<expression-id>
Policy > Inventory > Profiles > Context Profiles
Get PolicyContextProfiles
GET /policy/api/v1/global-infra/context-profiles
GET /policy/api/v1/infra/context-profiles
Policy > Inventory > Profiles > Context Profiles
Delete Policy Context Profile
DELETE /policy/api/v1/infra/context-profiles/<context-profile-id>
DELETE /policy/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Profiles > Context Profiles
Get PolicyContextProfile
GET /policy/api/v1/infra/context-profiles/<context-profile-id>
GET /policy/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Profiles > Context Profiles
Create PolicyContextProfile
PATCH /policy/api/v1/infra/context-profiles/<context-profile-id>
PATCH /policy/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Profiles > Context Profiles
Create PolicyContextProfile
PUT /policy/api/v1/infra/context-profiles/<context-profile-id>
PUT /policy/api/v1/global-infra/context-profiles/<context-profile-id>
Policy > Inventory > Profiles > Context Profiles
List Policy Context Profile supported attributes and sub-attributes
GET /policy/api/v1/infra/context-profiles/attributes
GET /policy/api/v1/global-infra/context-profiles/attributes
Policy > Inventory > Profiles > Context Profiles
Update custom object attribute value list for given attribute key
PATCH /policy/api/v1/global-infra/context-profiles/custom-attributes
PATCH /policy/api/v1/infra/context-profiles/custom-attributes
Policy > Inventory > Profiles > Context Profiles
Adds/Removes custom attribute values from list
POST /policy/api/v1/global-infra/context-profiles/custom-attributes
POST /policy/api/v1/infra/context-profiles/custom-attributes
Policy > Inventory > Profiles > Context Profiles
Update custom object attribute value list for given attribute key
GET /policy/api/v1/infra/context-profiles/custom-attributes/default
GET /policy/api/v1/global-infra/context-profiles/custom-attributes/default
Policy > Inventory > Profiles > Context Profiles
Update custom object attribute value list for given attribute key
PATCH /policy/api/v1/infra/context-profiles/custom-attributes/default
PATCH /policy/api/v1/global-infra/context-profiles/custom-attributes/default
Policy > Inventory > Profiles > Context Profiles
Adds/Removes custom attribute values from list
POST /policy/api/v1/infra/context-profiles/custom-attributes/default
POST /policy/api/v1/global-infra/context-profiles/custom-attributes/default
Policy > Inventory > Profiles > Context Profiles
List Policy L7 access profile supported attributes and sub-attributes
GET /policy/api/v1/infra/l7-access-profiles/attributes
Policy > Inventory > Profiles > L7 Access Profiles
List l7 access Profiles
GET /policy/api/v1/infra/l7-access-profiles
Policy > Inventory > Profiles > L7 Access Profiles
Delete L7 Access Profile
DELETE /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>
Policy > Inventory > Profiles > L7 Access Profiles
Get L7 Access Profile
GET /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>
Policy > Inventory > Profiles > L7 Access Profiles
Create or update L7 Access Profile
PATCH /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>
Policy > Inventory > Profiles > L7 Access Profiles
Update L7 Access Profile
PUT /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>
Policy > Inventory > Profiles > L7 Access Profiles
List l7 access profile entries
GET /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>/entries
Policy > Inventory > Profiles > L7 Access Profiles
Delete L7 Access Profile entry
DELETE /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>/entries/<l7-access-entry-id>
Policy > Inventory > Profiles > L7 Access Profiles
Read L7 Access Profile entry
GET /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>/entries/<l7-access-entry-id>
Policy > Inventory > Profiles > L7 Access Profiles
Create or update L7 Access Profile entry
PATCH /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>/entries/<l7-access-entry-id>
Policy > Inventory > Profiles > L7 Access Profiles
Create L7 Access Profile entry
PUT /policy/api/v1/infra/l7-access-profiles/<l7-access-profile-id>/entries/<l7-access-entry-id>
Policy > Inventory > Profiles > L7 Access Profiles > Static MIME Content
List static mime contents
GET /policy/api/v1/infra/static-mime-contents
Policy > Inventory > Profiles > L7 Access Profiles > Static MIME Content
Delete static Mime content
DELETE /policy/api/v1/infra/static-mime-contents/<static-mime-content-id>
Policy > Inventory > Profiles > L7 Access Profiles > Static MIME Content
Get Static Mime content
GET /policy/api/v1/infra/static-mime-contents/<static-mime-content-id>
Policy > Inventory > Profiles > L7 Access Profiles > Static MIME Content
Create or update static mime content id
PATCH /policy/api/v1/infra/static-mime-contents/<static-mime-content-id>
Policy > Inventory > Profiles > L7 Access Profiles > Static MIME Content
Update static mime content id
PUT /policy/api/v1/infra/static-mime-contents/<static-mime-content-id>
Policy > Inventory > Services
List Services for infra
GET /policy/api/v1/infra/services
GET /policy/api/v1/global-infra/services
Policy > Inventory > Services
Delete Service
DELETE /policy/api/v1/infra/services/<service-id>
Policy > Inventory > Services
Read a service
GET /policy/api/v1/infra/services/<service-id>
GET /policy/api/v1/global-infra/services/<service-id>
Policy > Inventory > Services
Patch a Service
PATCH /policy/api/v1/infra/services/<service-id>
Policy > Inventory > Services
Create or update a Service
PUT /policy/api/v1/infra/services/<service-id>
Policy > Inventory > Services
List Service entries for the given service
GET /policy/api/v1/global-infra/services/<service-id>/service-entries
GET /policy/api/v1/infra/services/<service-id>/service-entries
Policy > Inventory > Services
Delete Service entry
DELETE /policy/api/v1/infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Inventory > Services
Service entry
GET /policy/api/v1/global-infra/services/<service-id>/service-entries/<service-entry-id>
GET /policy/api/v1/infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Inventory > Services
Patch a ServiceEntry
PATCH /policy/api/v1/infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Inventory > Services
Create or update a ServiceEntry
PUT /policy/api/v1/infra/services/<service-id>/service-entries/<service-entry-id>
Policy > Inventory > Tags
List all unique tags.
GET /policy/api/v1/infra/tags
Policy > Inventory > Tags
List all objects assigned with matching scope and tag values
GET /policy/api/v1/infra/tags/effective-resources
Policy > Inventory > Tags
Get details of tag bulk operation request
GET /policy/api/v1/infra/tags/tag-operations/<operation-id>
Policy > Inventory > Tags
Assign or Unassign tag on multiple Virtual Machines.
PUT /policy/api/v1/infra/tags/tag-operations/<operation-id>
Policy > Inventory > Tags
Get status of tag bulk operation
GET /policy/api/v1/infra/tags/tag-operations/<operation-id>/status
Policy > Inventory > Virtual Interfaces
Return the List of Virtual Network Interfaces (VIFs)
GET /api/v1/fabric/vifs
Policy > Inventory > Virtual Machines
Return the List of Virtual Machines
GET /api/v1/fabric/virtual-machines
Policy > Inventory > Virtual Machines
Perform action on specified virtual machine e.g. update tags
POST /api/v1/fabric/virtual-machines?action=add_tags
Policy > Inventory > Virtual Machines
Perform action on specified virtual machine e.g. update tags
POST /api/v1/fabric/virtual-machines?action=remove_tags
Policy > Inventory > Virtual Machines
Perform action on specified virtual machine e.g. update tags
POST /api/v1/fabric/virtual-machines?action=update_tags
Policy > Inventory > Virtual Machines
Return the list of tools and agents installed in VMs.
GET /api/v1/fabric/virtual-machines/tools-info
Policy > Inventory > Virtual Machines
Listing of Virtual machines on the NSX Manager
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/virtual-machines (Deprecated)
Policy > Inventory > Virtual Machines
Apply tags on virtual machine
POST /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/virtual-machines?action=update_tags
Policy > Inventory > Virtual Machines
Read the details of a virtual machine on the NSX Manager
GET /policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/virtual-machines/<virtual-machine-id>/details
Policy > Inventory > Virtual Machines
Lists all the system excluded virtual machines.
GET /policy/api/v1/infra/realized-state/system-excluded-virtual-machines
Policy > Inventory > Virtual Machines
Lists all the system virtual machines.
GET /policy/api/v1/infra/realized-state/system-virtual-machines
Policy > Inventory > Virtual Machines
List all virtual machines which are not part of any group
GET /policy/api/v1/infra/realized-state/unassociated-virtual-machines
Policy > Inventory > Virtual Machines
List all virtual machines
GET /policy/api/v1/infra/realized-state/virtual-machines
Policy > Inventory > Virtual Switches
Return the List of Virtual Switches
GET /api/v1/fabric/virtual-switches
Policy > Inventory > Vm
List all VM tag replication policies
GET /policy/api/v1/global-infra/vm-tag-replication-policies
Policy > Inventory > Vm
Get the VM tag replication policy specified by id
GET /policy/api/v1/global-infra/vm-tag-replication-policies/<id>
Policy > Monitoring > Capacity Dashboard
Returns capacity usage data for NSX objects
GET /policy/api/v1/infra/capacity/dashboard/usage
Policy > Monitoring > Capacity Dashboard
Returns warning threshold(s) set for NSX Objects.
GET /policy/api/v1/infra/capacity/threshold
Policy > Monitoring > Capacity Dashboard
Updates the thresholds for specified NSX Objects.
PATCH /policy/api/v1/infra/capacity/threshold
Policy > Monitoring > Capacity Dashboard
Updates the warning threshold(s) for NSX Objects.
PUT /policy/api/v1/infra/capacity/threshold
Policy > Monitoring > Capacity Dashboard
Returns capacity usage data for NSX objects
GET /policy/api/v1/infra/capacity/usage (Deprecated)
Policy > Monitoring > Compliance
Returns the compliance status
GET /policy/api/v1/compliance/status
Policy > Monitoring > Finetuning
For each type of entity what are the attributes owned by policy.
GET /policy/api/v1/fine-tuning/resources
Policy > Monitoring > Heatmap
Get the details of latency status for all appliances
GET /policy/api/v1/infra/sha/appliances/latency/status
Policy > Monitoring > Heatmap
Get all the container cluster status
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/container-cluster-ncpstatus
Policy > Monitoring > Heatmap
Create container cluster status
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/container-cluster-ncpstatus
Policy > Monitoring > Heatmap
Delete container cluster status
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/container-cluster/<cluster-id>/ncpstatus
Policy > Monitoring > Heatmap
Get the container cluster status by given id
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/container-cluster/<cluster-id>/ncpstatus
Policy > Monitoring > Heatmap
Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes-aggstatus
Policy > Monitoring > Heatmap
Read status of all the transport nodes
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes-status
Policy > Monitoring > Heatmap
Get the container hyperbus status on given node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/hyperbus-status
Policy > Monitoring > Heatmap
Get the container status on given node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/node-agent-status
Policy > Monitoring > Heatmap
Get high-level summary of a transport node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/pnic-bond-status
Policy > Monitoring > Heatmap
Read status of all transport nodes with tunnel connections to transport node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/remote-transport-node-status
Policy > Monitoring > Heatmap
Read status of a transport node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/status
Policy > Monitoring > Heatmap
List of tunnels
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/tunnels
Policy > Monitoring > Heatmap
Tunnel properties
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/tunnels/<tunnel-name>
Policy > Monitoring > Heatmap
Creates a status report of transport nodes of all the transport zones
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/transport-node-status-report
Policy > Monitoring > Heatmap
Get high-level summary of all transport zone status. The service layer does not support source = realtime or cached.
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/transport-zones-aggstatus
Policy > Monitoring > Heatmap
Get high-level summary of a transport zone
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/transport-zones/<zone-id>/status
Policy > Monitoring > Heatmap
Read status of transport nodes in a transport zone
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/transport-zones/<zone-id>/transport-node-status
Policy > Monitoring > Heatmap
Creates a status report of transport nodes in a transport zone
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/transport-zones/<zone-id>/transport-node-status-report
Policy > Monitoring > IPFIX > Firewall IPFIX Collectors
List IPFIX Collector profiles.
GET /policy/api/v1/global-infra/ipfix-dfw-collector-profiles
GET /policy/api/v1/infra/ipfix-dfw-collector-profiles
Policy > Monitoring > IPFIX > Firewall IPFIX Collectors
Delete IPFIX dfw Collector profile
DELETE /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Monitoring > IPFIX > Firewall IPFIX Collectors
Get IPFIX dfw Collector profile
GET /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
GET /policy/api/v1/global-infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Monitoring > IPFIX > Firewall IPFIX Collectors
IPFIX dfw collector profile id
PATCH /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Monitoring > IPFIX > Firewall IPFIX Collectors
Create or Replace IPFIX dfw collector profile
PUT /policy/api/v1/infra/ipfix-dfw-collector-profiles/<ipfix-dfw-collector-profile-id>
Policy > Monitoring > IPFIX > Firewall IPFIX Profiles
List IPFIX DFW Profile
GET /policy/api/v1/infra/ipfix-dfw-profiles
GET /policy/api/v1/global-infra/ipfix-dfw-profiles
Policy > Monitoring > IPFIX > Firewall IPFIX Profiles
Delete IPFIX DFW Profile
DELETE /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Monitoring > IPFIX > Firewall IPFIX Profiles
Get IPFIX DFW Profile
GET /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
GET /policy/api/v1/global-infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Monitoring > IPFIX > Firewall IPFIX Profiles
Patch IPFIX DFW profile
PATCH /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Monitoring > IPFIX > Firewall IPFIX Profiles
Create or Replace IPFIX DFW collection Config.
PUT /policy/api/v1/infra/ipfix-dfw-profiles/<ipfix-dfw-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Collectors
List IPFIX Collector profiles.
GET /policy/api/v1/infra/ipfix-l2-collector-profiles
GET /policy/api/v1/global-infra/ipfix-l2-collector-profiles
Policy > Monitoring > IPFIX > Switch IPFIX Collectors
Delete IPFIX Collector profile
DELETE /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
DELETE /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Collectors
Get IPFIX Collector profile
GET /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
GET /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Collectors
Patch IPFIX collector profile
PATCH /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
PATCH /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Collectors
Create or Replace IPFIX collector profile
PUT /policy/api/v1/global-infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
PUT /policy/api/v1/infra/ipfix-l2-collector-profiles/<ipfix-l2-collector-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Profiles
List IPFIX L2 Profiles
GET /policy/api/v1/infra/ipfix-l2-profiles
GET /policy/api/v1/global-infra/ipfix-l2-profiles
Policy > Monitoring > IPFIX > Switch IPFIX Profiles
Delete IPFIX L2 Profile
DELETE /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
DELETE /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Profiles
Get IPFIX L2 Profile
GET /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
GET /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Profiles
Patch IPFIX L2profile
PATCH /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
PATCH /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Monitoring > IPFIX > Switch IPFIX Profiles
Create or Replace IPFIX L2 profile
PUT /policy/api/v1/infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
PUT /policy/api/v1/global-infra/ipfix-l2-profiles/<ipfix-l2-profile-id>
Policy > Monitoring > LLDP
List LLDP Neighbor Properties of given Node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/lldp/interfaces
Policy > Monitoring > LLDP
Read LLDP Neighbor Properties of transport node by Interface Name
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/host-transport-nodes/<node-id>/lldp/interfaces/<interface-name>
Policy > Monitoring > Latency
List latency profiles
GET /policy/api/v1/infra/latency-profiles
Policy > Monitoring > Latency
Delete an existing latency profile
DELETE /policy/api/v1/infra/latency-profiles/<profile-id>
Policy > Monitoring > Latency
Read latency profile
GET /policy/api/v1/infra/latency-profiles/<profile-id>
Policy > Monitoring > Latency
Patch latency profile
PATCH /policy/api/v1/infra/latency-profiles/<profile-id>
Policy > Monitoring > Latency
Create or Replace latency profile
PUT /policy/api/v1/infra/latency-profiles/<profile-id>
Policy > Monitoring > Livetrace
List livetrace config entities
GET /policy/api/v1/infra/livetraces
Policy > Monitoring > Livetrace
Delete a livetrace config
DELETE /policy/api/v1/infra/livetraces/<livetrace-id>
Policy > Monitoring > Livetrace
Read a livetrace config
GET /policy/api/v1/infra/livetraces/<livetrace-id>
Policy > Monitoring > Livetrace
Create or update a livetrace config
PATCH /policy/api/v1/infra/livetraces/<livetrace-id>
Policy > Monitoring > Livetrace
Restart a livetrace session
POST /policy/api/v1/infra/livetraces/<livetrace-id>
Policy > Monitoring > Livetrace
Create or update a livetrace config
PUT /policy/api/v1/infra/livetraces/<livetrace-id>
Policy > Monitoring > Livetrace
Read livetrace result
GET /policy/api/v1/infra/livetraces/<livetrace-id>/result
Policy > Monitoring > Livetrace
Read livetrace status
GET /policy/api/v1/infra/livetraces/<livetrace-id>/status
Policy > Monitoring > Livetrace
List livetrace status entities
GET /policy/api/v1/infra/livetraces/statuses
Policy > Monitoring > Port Mirroring
List Port Mirroring Profiles
GET /policy/api/v1/global-infra/port-mirroring-profiles
GET /policy/api/v1/infra/port-mirroring-profiles
Policy > Monitoring > Port Mirroring
Delete Port Mirroring Profile
DELETE /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
DELETE /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Monitoring > Port Mirroring
Details of Port Mirroring Profile
GET /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
GET /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Monitoring > Port Mirroring
Patch Port Mirroring Profile.
PATCH /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
PATCH /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Monitoring > Port Mirroring
Create or Replace Port Mirroring Profile.
PUT /policy/api/v1/infra/port-mirroring-profiles/<port-mirroring-profile-id>
PUT /policy/api/v1/global-infra/port-mirroring-profiles/<port-mirroring-profile-id>
Policy > Monitoring > System Health Agent > Appliance
Get the details of latency status in given appliance.
GET /policy/api/v1/infra/sha/appliances/<appliance-id>/latency/status
Policy > Monitoring > System Health Agent > Appliance
Get the details of process status in given appliance.
GET /policy/api/v1/infra/sha/appliances/<appliance-id>/process/status
Policy > Monitoring > System Health Agent > Appliance
Get the list of process status for all appliances.
GET /policy/api/v1/infra/sha/appliances/process/status
Policy > Monitoring > System Health Agent > Profile
API will provide list of Sha dynamic plugin list.
GET /policy/api/v1/infra/sha/dynamic-plugins
GET /policy/api/v1/global-infra/sha/dynamic-plugins
Policy > Monitoring > System Health Agent > Profile
Read Sha dynamic plugin
DELETE /policy/api/v1/infra/sha/dynamic-plugins/<plugin-id>
Policy > Monitoring > System Health Agent > Profile
Read Sha dynamic plugin
GET /policy/api/v1/global-infra/sha/dynamic-plugins/<plugin-id>
GET /policy/api/v1/infra/sha/dynamic-plugins/<plugin-id>
Policy > Monitoring > System Health Agent > Profile
Upload Sha dynamic plugin
PATCH /policy/api/v1/infra/sha/dynamic-plugins/<plugin-id>
Policy > Monitoring > System Health Agent > Profile
Create Sha dynamic plugin
PUT /policy/api/v1/infra/sha/dynamic-plugins/<plugin-id>
Policy > Monitoring > System Health Agent > Profile
Upload Sha dynamic plugin
POST /policy/api/v1/infra/sha/dynamic-plugins/<plugin-id>/files/<file-name>
Policy > Monitoring > System Health Agent > Profile
API will provide list of SHA profile.
GET /policy/api/v1/infra/sha/plugin-profiles
GET /policy/api/v1/global-infra/sha/plugin-profiles
Policy > Monitoring > System Health Agent > Profile
Delete SHA profile
DELETE /policy/api/v1/infra/sha/plugin-profiles/<sha-profile-id>
Policy > Monitoring > System Health Agent > Profile
API will return Sha profile
GET /policy/api/v1/global-infra/sha/plugin-profiles/<sha-profile-id>
GET /policy/api/v1/infra/sha/plugin-profiles/<sha-profile-id>
Policy > Monitoring > System Health Agent > Profile
Create or Replace SHA profile
PATCH /policy/api/v1/infra/sha/plugin-profiles/<sha-profile-id>
Policy > Monitoring > System Health Agent > Profile
Create or Replace Sha profile
PUT /policy/api/v1/infra/sha/plugin-profiles/<sha-profile-id>
Policy > Monitoring > System Health Agent > Profile
Show the plugins status on given node.
GET /policy/api/v1/infra/sha/plugin-status/<node-id>
GET /policy/api/v1/global-infra/sha/plugin-status/<node-id>
Policy > Monitoring > System Health Agent > Profile
API will provide list of Sha pre-defined list.
GET /policy/api/v1/global-infra/sha/pre-defined-plugins
GET /policy/api/v1/infra/sha/pre-defined-plugins
Policy > Monitoring > System Health Agent > Profile
Read Sha pre-defined plugin
GET /policy/api/v1/infra/sha/pre-defined-plugins/<plugin-id>
GET /policy/api/v1/global-infra/sha/pre-defined-plugins/<plugin-id>
Policy > Monitoring > Traceflow
List AntreaTraceflowConfig for infra
GET /policy/api/v1/infra/antrea/traceflows
Policy > Monitoring > Traceflow
Delete Antrea traceflow config
DELETE /policy/api/v1/infra/antrea/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Read Antrea traceflow config
GET /policy/api/v1/infra/antrea/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Create an Antrea traceflow config
PATCH /policy/api/v1/infra/antrea/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Restart Antrea traceflow with same set of parameters used during create traceflow
POST /policy/api/v1/infra/antrea/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Create an Antrea traceflow config
PUT /policy/api/v1/infra/antrea/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Read Antrea traceflow observations
GET /policy/api/v1/infra/antrea/traceflows/<traceflow-id>/observations
Policy > Monitoring > Traceflow
Read Antrea traceflow status
GET /policy/api/v1/infra/antrea/traceflows/<traceflow-id>/status
Policy > Monitoring > Traceflow
List TraceflowConfig for infra
GET /policy/api/v1/global-infra/traceflows
GET /policy/api/v1/infra/traceflows
Policy > Monitoring > Traceflow
Delete traceflow config
DELETE /policy/api/v1/infra/traceflows/<traceflow-id>
DELETE /policy/api/v1/global-infra/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Read traceflow config
GET /policy/api/v1/infra/traceflows/<traceflow-id>
GET /policy/api/v1/global-infra/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Create or update a traceflow config
PATCH /policy/api/v1/infra/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Restart traceflow with same set of parameters used during create/update traceflow
POST /policy/api/v1/infra/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Create or update a traceflow config
PUT /policy/api/v1/infra/traceflows/<traceflow-id>
Policy > Monitoring > Traceflow
Read traceflow observations
GET /policy/api/v1/infra/traceflows/<traceflow-id>/observations
Policy > Monitoring > Traceflow
Read traceflow status
GET /policy/api/v1/infra/traceflows/<traceflow-id>/status
Policy > Networking > Connectivity > Segments
Get downlink port Address Resolution Protocol Proxies for infra segment in CSV format
GET /policy/api/v1/infra/segments/<segment-id>/arp-proxy?format=csv
GET /policy/api/v1/global-infra/segments/<segment-id>/arp-proxy?format=csv
Policy > Networking > Connectivity > Segments
Get downlink port Address Resolution Protocol Proxies for infra segment
GET /policy/api/v1/global-infra/segments/<segment-id>/arp-proxy
GET /policy/api/v1/infra/segments/<segment-id>/arp-proxy
Policy > Networking > Connectivity > Segments
Get downlink port Address Resolution Protocol Proxies for tier-1 segment
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-proxy
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-proxy
Policy > Networking > Connectivity > Segments
Get downlink port Address Resolution Protocol Proxies for tier-1 segment in CSV
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-proxy?format=csv
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics
Get infra segment bridge end point statistics using segment ID and profile path.
GET /policy/api/v1/infra/segments/<segment-id>/bep-statistics
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics
Get Tier-1 segment bridge end point status using segment ID and profile path.
GET /policy/api/v1/infra/segments/<segment-id>/bep-status
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics
Get Tier-1 segment bridge end point statistics using segment ID and profile path.
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/bep-statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/bep-statistics
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics
Get Tier-1 segment bridge end point status using segment ID and profile path.
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/bep-status
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/bep-status
Policy > Networking > Connectivity > Segments > Edge Bridge Profiles
List L2 Bridge Endpoint Profiles
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-bridge-profiles
Policy > Networking > Connectivity > Segments > Edge Bridge Profiles
Delete L2 Bridge Endpoint Profile
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-bridge-profiles/<profile-id>
Policy > Networking > Connectivity > Segments > Edge Bridge Profiles
Get L2 Bridge Endpoint Profile
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-bridge-profiles/<profile-id>
Policy > Networking > Connectivity > Segments > Edge Bridge Profiles
Create or update L2 Bridge Endpoint Profile
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-bridge-profiles/<profile-id>
Policy > Networking > Connectivity > Segments > Edge Bridge Profiles
Create or update L2 Bridge Endpoint Profile
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-bridge-profiles/<profile-id>
Policy > Networking > Connectivity > Segments > MAC Table
Get infra segment MAC table in CSV
GET /policy/api/v1/infra/segments/<segment-id>/mac-table?format=csv
GET /policy/api/v1/global-infra/segments/<segment-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segments > MAC Table
Get infra segment MAC table
GET /policy/api/v1/infra/segments/<segment-id>/mac-table
GET /policy/api/v1/global-infra/segments/<segment-id>/mac-table
Policy > Networking > Connectivity > Segments > MAC Table
Get Tier-1 segment MAC table
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/mac-table
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/mac-table
Policy > Networking > Connectivity > Segments > MAC Table
Get Tier-1 segment MAC table in CSV
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/mac-table?format=csv
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segments > Ports
List infra segment ports
GET /policy/api/v1/infra/segments/<segment-id>/ports
GET /policy/api/v1/global-infra/segments/<segment-id>/ports
Policy > Networking > Connectivity > Segments > Ports
Delete an infra segment port
DELETE /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>
DELETE /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
Get infra segment port by ID
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
Patch an infra segment port
PATCH /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>
PATCH /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
Create or update an infra segment port
PUT /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>
PUT /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
List Tier-1 segment ports
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports
Policy > Networking > Connectivity > Segments > Ports
Delete a Tier-1 segment port
DELETE /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
Get Tier-1 segment port by ID
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
Patch a Tier-1 segment port
PATCH /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports
Create or update a Tier-1 segment port
PUT /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>
Policy > Networking > Connectivity > Segments > Ports > MAC Table
Get infra segment port MAC table in CSV
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/mac-table?format=csv
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segments > Ports > MAC Table
Get MAC table for infra segment port
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/mac-table
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/mac-table
Policy > Networking > Connectivity > Segments > Ports > MAC Table
Get tier-1 segment port MAC table in CSV
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/mac-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/mac-table?format=csv
Policy > Networking > Connectivity > Segments > Ports > MAC Table
Get MAC table for tier-1 segment port
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/mac-table
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/mac-table
Policy > Networking > Connectivity > Segments > Ports > State
Get infra segment port state
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/state
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/state
Policy > Networking > Connectivity > Segments > Ports > State
Get tier-1 segment port state
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/state
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Group discovery profile binding map
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Group discovery profile binding map
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Group discovery profile binding map
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create or update Group discovery profile binding map
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Group discovery profile binding map
PUT /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/discovery-profile-binding-maps/<discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Infra Port Discovery Profile Binding Maps
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps
GET /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Infra Port Discovery Profile Binding Profile
DELETE /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
DELETE /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Infra Port Discovery Profile Binding Map
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
GET /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create Infra Port Discovery Profile Binding Map
PATCH /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
PATCH /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Infra Port Discovery Profile Binding Map
PUT /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
PUT /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Infra Segment Discovery Profile Binding Maps
GET /policy/api/v1/infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Segment Discovery Profile Binding Profile
DELETE /policy/api/v1/infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Infra Segment Discovery Profile Binding Map
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
GET /policy/api/v1/infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create Infra Segment Discovery Profile Binding Map
PATCH /policy/api/v1/infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Infra Segment Discovery Profile Binding Map
PUT /policy/api/v1/infra/segments/<infra-segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Port Discovery Profile Binding Maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Port Discovery Profile Binding Profile
DELETE /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Port Discovery Profile Binding Map
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create Port Discovery Profile Binding Map
PATCH /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Port Discovery Profile Binding Map
PUT /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps/<port-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
List Segment Discovery Profile Binding Maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Delete Segment Discovery Profile Binding Profile
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Get Segment Discovery Profile Binding Map
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Create Segment Discovery Profile Binding Map
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Discovery Profile Binding
Update Segment Discovery Profile Binding Map
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-discovery-profile-binding-maps/<segment-discovery-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
List IP Discovery Profiles
GET /policy/api/v1/global-infra/ip-discovery-profiles
GET /policy/api/v1/infra/ip-discovery-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Delete IP Discovery Profile
DELETE /policy/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
DELETE /policy/api/v1/infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Get IP Discovery Profile
GET /policy/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
GET /policy/api/v1/infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Create IP Discovery Profile
PATCH /policy/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
PATCH /policy/api/v1/infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > IP Discovery Profiles
Update IP Discovery Profile
PUT /policy/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>
PUT /policy/api/v1/infra/ip-discovery-profiles/<ip-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
List Mac Discovery Profiles
GET /policy/api/v1/global-infra/mac-discovery-profiles
GET /policy/api/v1/infra/mac-discovery-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Delete Mac Discovery Profile
DELETE /policy/api/v1/infra/mac-discovery-profiles/<mac-discovery-profile-id>
DELETE /policy/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Get Mac Discovery Profile
GET /policy/api/v1/infra/mac-discovery-profiles/<mac-discovery-profile-id>
GET /policy/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Create Mac Discovery Profile
PATCH /policy/api/v1/infra/mac-discovery-profiles/<mac-discovery-profile-id>
PATCH /policy/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > MAC Discovery Profiles
Update Mac Discovery Profile
PUT /policy/api/v1/infra/mac-discovery-profiles/<mac-discovery-profile-id>
PUT /policy/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Group Monitoring Profile Binding Map.
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>/mirror-stack-status
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Infra Port Monitoring Profile Binding Maps
GET /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Delete Infra Port Monitoring Profile Binding Profile
DELETE /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Infra Port Monitoring Profile Binding Map
GET /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Create Infra Port Monitoring Profile Binding Map
PATCH /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Update Infra Port Monitoring Profile Binding Map
PUT /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Infra Port Monitoring Profile Binding Map
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
GET /policy/api/v1/infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Infra Segment Monitoring Profile Binding Maps
GET /policy/api/v1/infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Delete Infra Segment Monitoring Profile Binding Profile
DELETE /policy/api/v1/infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Infra Segment Monitoring Profile Binding Map
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
GET /policy/api/v1/infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Create Infra Segment Monitoring Profile Binding Map
PATCH /policy/api/v1/infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Update Infra Segment Monitoring Profile Binding Map
PUT /policy/api/v1/infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Infra Segment Monitoring Profile Binding Map
GET /policy/api/v1/infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
GET /policy/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Port Monitoring Profile Binding Maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Delete Port Monitoring Profile Binding Profile
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Port Monitoring Profile Binding Map
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Create Port Monitoring Profile Binding Map
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Update Port Monitoring Profile Binding Map
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Port Monitoring Profile Binding Map
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
List Segment Monitoring Profile Binding Maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Delete Segment Monitoring Profile Binding Profile
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get Segment Monitoring Profile Binding Map
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Create Segment Monitoring Profile Binding Map
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Update Segment Monitoring Profile Binding Map
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding
Get mirror stack status for Segment Monitoring Profile Binding Map
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Port QoS Profile Binding Maps
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Delete Port QoS Profile Binding Profile
DELETE /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
DELETE /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Port QoS Profile Binding Map
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Create Port QoS Profile Binding Map
PATCH /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
PATCH /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Update Port QoS Profile Binding Map
PUT /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
PUT /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Segment QoS Profile Binding Maps
GET /policy/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps
GET /policy/api/v1/infra/segments/<segment-id>/segment-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Delete Segment QoS Profile Binding Profile
DELETE /policy/api/v1/infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Segment QoS Profile Binding Map
GET /policy/api/v1/infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
GET /policy/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Create Segment QoS Profile Binding Map
PATCH /policy/api/v1/infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Update Segment QoS Profile Binding Map
PUT /policy/api/v1/infra/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Port QoS Profile Binding Maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Delete Port QoS Profile Binding Profile
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
DELETE /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Port QoS Profile Binding Map
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Create Port QoS Profile Binding Map
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
PATCH /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Update Port QoS Profile Binding Map
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
PUT /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps/<port-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
List Segment QoS Profile Binding Maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Delete Segment QoS Profile Binding Profile
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Get Segment QoS Profile Binding Map
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Create Segment QoS Profile Binding Map
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profile Binding
Update Segment QoS Profile Binding Map
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-qos-profile-binding-maps/<segment-qos-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
List QoS Profiles
GET /policy/api/v1/infra/qos-profiles
GET /policy/api/v1/global-infra/qos-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Delete QoS profile
DELETE /policy/api/v1/infra/qos-profiles/<qos-profile-id>
DELETE /policy/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Details of QoS profile
GET /policy/api/v1/infra/qos-profiles/<qos-profile-id>
GET /policy/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Patch QoS profile.
PATCH /policy/api/v1/infra/qos-profiles/<qos-profile-id>
PATCH /policy/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > QOS Profiles
Create or Replace QoS profile.
PUT /policy/api/v1/infra/qos-profiles/<qos-profile-id>
PUT /policy/api/v1/global-infra/qos-profiles/<qos-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Security Profile Binding
Patch segment security profile binding map
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List infra segment port security profile binding maps
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Delete the infra segment port security profile binding map
DELETE /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
DELETE /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get infra segment port security profile binding map
GET /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
GET /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Patch infra segment port security profile binding map
PATCH /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
PATCH /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Create or replace the infra segment port security profile binding map
PUT /policy/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
PUT /policy/api/v1/infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List infra segment security profile binding maps
GET /policy/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps
GET /policy/api/v1/infra/segments/<segment-id>/segment-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Delete infra segment security profile binding map
DELETE /policy/api/v1/infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get infra segment security profile binding map
GET /policy/api/v1/infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
GET /policy/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Patch infra segment security profile binding map
PATCH /policy/api/v1/infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Create or replace infra segment security profile binding map
PUT /policy/api/v1/infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List port security profile binding maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Delete the port security profile binding map
DELETE /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get port security profile binding map
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Patch port security profile binding map
PATCH /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Create or replace the port security profile binding map
PUT /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
List segment security profile binding maps
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Delete segment security profile binding map
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Get segment security profile binding map
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profile Binding
Create or replace segment security profile binding map
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
List segment security profiles
GET /policy/api/v1/global-infra/segment-security-profiles
GET /policy/api/v1/infra/segment-security-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
DELETE segment security profile
DELETE /policy/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
DELETE /policy/api/v1/infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
GET Segment security profile id
GET /policy/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
GET /policy/api/v1/infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
PATCH segment security profile id
PATCH /policy/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
PATCH /policy/api/v1/infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Segment Security Profiles
PUT segment security profile id
PUT /policy/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>
PUT /policy/api/v1/infra/segment-security-profiles/<segment-security-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
List SpoofGuard profiles
GET /policy/api/v1/global-infra/spoofguard-profiles
GET /policy/api/v1/infra/spoofguard-profiles
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Delete SpoofGuard profile
DELETE /policy/api/v1/infra/spoofguard-profiles/<spoofguard-profile-id>
DELETE /policy/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Get SpoofGuard profile
GET /policy/api/v1/infra/spoofguard-profiles/<spoofguard-profile-id>
GET /policy/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Patch SpoofGuard profile
PATCH /policy/api/v1/infra/spoofguard-profiles/<spoofguard-profile-id>
PATCH /policy/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segment Profiles > Spoofguard Profiles
Create or replace SpoofGuard profile
PUT /policy/api/v1/infra/spoofguard-profiles/<spoofguard-profile-id>
PUT /policy/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>
Policy > Networking > Connectivity > Segments > Segments
List all segments under infra
GET /policy/api/v1/infra/segments
GET /policy/api/v1/global-infra/segments
Policy > Networking > Connectivity > Segments > Segments
Delete infra segment
DELETE /policy/api/v1/infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Force delete infra segment
DELETE /policy/api/v1/infra/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments
Read infra segment
GET /policy/api/v1/infra/segments/<segment-id>
GET /policy/api/v1/global-infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Create or update a segment
PATCH /policy/api/v1/infra/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments
Create or update a segment
PATCH /policy/api/v1/infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Create or update a infra segment
PUT /policy/api/v1/infra/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments
Create or update a infra segment
PUT /policy/api/v1/infra/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Delete segment
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Force delete segment
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>?force=true
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Read segment
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a segment
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a segment
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Delete static ARP config
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Read static ARP config
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a static ARP config
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > Segments (Fixed)
Create or update a static ARP config
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp
Policy > Networking > Connectivity > Segments > Service Segments
List Service Segments
GET /policy/api/v1/infra/segments/service-segments
Policy > Networking > Connectivity > Segments > Service Segments
Delete Service Segment
DELETE /policy/api/v1/infra/segments/service-segments/<service-segment-id>
Policy > Networking > Connectivity > Segments > Service Segments
Read Service Segment
GET /policy/api/v1/infra/segments/service-segments/<service-segment-id>
Policy > Networking > Connectivity > Segments > Service Segments
Create a service segment
PATCH /policy/api/v1/infra/segments/service-segments/<service-segment-id>
Policy > Networking > Connectivity > Segments > Service Segments
Create service segment
PUT /policy/api/v1/infra/segments/service-segments/<service-segment-id>
Policy > Networking > Connectivity > Segments > State
Get infra segment state information
GET /policy/api/v1/infra/segments/<segments-id>/state
GET /policy/api/v1/global-infra/segments/<segments-id>/state
Policy > Networking > Connectivity > Segments > State
Get segment state information
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segments-id>/state
Policy > Networking > Connectivity > Segments > State
Get tier-1 segments by configuration state
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/state
Policy > Networking > Connectivity > Segments > Statistics
Get infra segment port statistics information
GET /policy/api/v1/infra/segments/<segments-id>/ports/<port-id>/statistics
GET /policy/api/v1/global-infra/segments/<segments-id>/ports/<port-id>/statistics
Policy > Networking > Connectivity > Segments > Statistics
Get infra segment statistics information
GET /policy/api/v1/global-infra/segments/<segments-id>/statistics
GET /policy/api/v1/infra/segments/<segments-id>/statistics
Policy > Networking > Connectivity > Segments > Statistics
Get infra segments by configuration state
GET /policy/api/v1/infra/segments/state
GET /policy/api/v1/global-infra/segments/state
Policy > Networking > Connectivity > Segments > Statistics
Get tier-1 segment port statistics information
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/ports/<port-id>/statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segments-id>/ports/<port-id>/statistics
Policy > Networking > Connectivity > Segments > Statistics
Get segment statistics information
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segments-id>/statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/statistics
Policy > Networking > Connectivity > Segments > Status
Get infra segment port status information
GET /policy/api/v1/global-infra/segments/<segments-id>/ports/<port-id>/status
GET /policy/api/v1/infra/segments/<segments-id>/ports/<port-id>/status
Policy > Networking > Connectivity > Segments > Status
Get segment port status information
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segments-id>/ports/<port-id>/status
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/ports/<port-id>/status
Policy > Networking > Connectivity > Segments > TEP Table
Get infra segment TEP table
GET /policy/api/v1/infra/segments/<segment-id>/tep-table
GET /policy/api/v1/global-infra/segments/<segment-id>/tep-table
Policy > Networking > Connectivity > Segments > TEP Table
Get tier-1 segment TEP table in CSV
GET /policy/api/v1/global-infra/segments/<segment-id>/tep-table?format=csv
GET /policy/api/v1/infra/segments/<segment-id>/tep-table?format=csv
Policy > Networking > Connectivity > Segments > TEP Table
Get tier-1 segment TEP table in CSV
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/tep-table?format=csv
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/tep-table?format=csv
Policy > Networking > Connectivity > Segments > TEP Table
Get tier-1 segment TEP table
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/tep-table
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/tep-table
Policy > Networking > Connectivity > Tier-0 Gateways > ARP Proxies
Get Tier-0 Address Resolution Protocol Proxies
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/arp-proxies
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/arp-proxies
Policy > Networking > Connectivity > Tier-0 Gateways > ARP Proxies
Get Tier-0 Address Resolution Protocol Proxies in CSV format
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/arp-proxies?format=csv
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/arp-proxies?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > ARP Proxies
Get Tier-0 Address Resolution Protocol Proxies
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/arp-proxies (Deprecated)
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/arp-proxies (Deprecated)
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Configuration
Read Evpn Configuration
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/evpn
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Configuration
Create or Update evpn configuration
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/evpn
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Configuration
Create or Update evpn configuration
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/evpn
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Tunnel Endpoints
Delete evpn tunnel endpoint configuration
DELETE /policy/api/v1/infra/evpn-tenant-configs/<config-id>
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Tunnel Endpoints
List evpn tunnel endpoint configuration
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/evpn-tunnel-endpoints
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Tunnel Endpoints
Delete evpn tunnel endpoint configuration
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/evpn-tunnel-endpoints/<tunnel-endpoint-id>
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Tunnel Endpoints
Read evpn tunnel endpoint configuration
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/evpn-tunnel-endpoints/<tunnel-endpoint-id>
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Tunnel Endpoints
Create or Update evpn tunnel endpoint configuration
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/evpn-tunnel-endpoints/<tunnel-endpoint-id>
Policy > Networking > Connectivity > Tier-0 Gateways > EVPN Setting > EVPN Tunnel Endpoints
Create or Update evpn tunnel endpoint configuration
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/evpn-tunnel-endpoints/<tunnel-endpoint-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Proxies
Get Tier-0 Interface Address Resolution Protocol Proxies in CSV format
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy?format=csv
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Proxies
Get Tier-0 Interface Address Resolution Protocol Proxies
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink)
GET /policy/api/v1/infra/segments/<segment-id>/arp-table
GET /policy/api/v1/global-infra/segments/<segment-id>/arp-table
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink) in CSV format
GET /policy/api/v1/global-infra/segments/<segment-id>/arp-table?format=csv
GET /policy/api/v1/infra/segments/<segment-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-0 router
GET /policy/api/v1/global-infra/segments/<segment-id>/gateway-interface-arp-table (Deprecated)
GET /policy/api/v1/infra/segments/<segment-id>/gateway-interface-arp-table (Deprecated)
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-0 router in CSV
GET /policy/api/v1/global-infra/segments/<segment-id>/gateway-interface-arp-table?format=csv (Deprecated)
GET /policy/api/v1/infra/segments/<segment-id>/gateway-interface-arp-table?format=csv (Deprecated)
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from tier-0 interface in CSV format
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table?format=csv
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from tier-0 interface
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get tier-0 router link arp information
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/tier-1-interface/arp-table
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/tier-1-interface/arp-table
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table
Get ARP table from tier-0 router link interface in CSV format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/tier-1-interface/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/tier-1-interface/arp-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > DAD State
Get DAD state for downlink router port on tier-0 router
GET /policy/api/v1/infra/segments/<segment-id>/gateway-interface-dad-state
GET /policy/api/v1/global-infra/segments/<segment-id>/gateway-interface-dad-state
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > DAD State
Get DAD status by interface
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/dad-state
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/dad-state
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > DAD State
Get DAD status by interface
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/dad-state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/dad-state
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
List Tier-0 Interfaces
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Delete Tier-0 interface
DELETE /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Read Tier-0 interface
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create or update a Tier-0 interface
PATCH /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create or update a Tier-0 interface
PUT /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
List Service Interfaces
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Delete service interface
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Read service interface
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create or update a Tier-0 interface
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Interfaces
Create a service interface
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-0 router
GET /policy/api/v1/global-infra/segments/<segment-id>/gateway-interface-statistics
GET /policy/api/v1/infra/segments/<segment-id>/gateway-interface-statistics
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-0 router
GET /policy/api/v1/global-infra/segments/<segment-id>/gateway-interface-statistics/summary
GET /policy/api/v1/infra/segments/<segment-id>/gateway-interface-statistics/summary
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get tier-0 interface statistics information
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get tier-0 interface statistics summary information
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get tier-0 router link statistics information
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/tier-1-interface/statistics
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/tier-1-interface/statistics
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > Statistics
Get tier-0 router link statistics summary information
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/tier-1-interface/statistics/summary
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/tier-1-interface/statistics/summary
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Delete Pim Profile
DELETE /policy/api/v1/infra/pim-profiles/<pim-profile-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Read Multicast Configuration
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Create or update multicast configuration
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Create or update multicast configuration
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get Multicast Forwarding In Csv Format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/forwarding?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get Multicast Forwarding
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/forwarding
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get IGMP Memberships in CSV format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/igmp-memberships?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get IGMP Memberships
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/igmp-memberships
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get PIM Rendezvous Point Mappings In CSV Format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/pim-rp-mappings?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get PIM Rendezvous Point Mappings
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/pim-rp-mappings
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get Multicast Routes in Csv Format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/routes?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Multicast
Get Multicast Routes
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Delete overridden BGP routing config
DELETE /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Read BGP routing config
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update BGP routing config
PATCH /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update a BGP routing config
PUT /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
List BGP neighbor configurations
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Delete BGP neighbor config
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
DELETE /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Read BGP neighbor config
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update a BGP neighbor config
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
PATCH /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Create or update a BGP neighbor config
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
PUT /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get BGP neighbor advertised routes
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get BGP neighbor advertised routes in CSV format
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes?format=csv
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get routes learned by BGP neighbor in CSV format
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes?format=csv
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get routes learned by BGP neighbor
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP
Get BGP neighbor status for the Tier0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/status
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/status
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
List BGP community lists
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/community-lists
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Delete a BGP community list
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Read a BGP community list
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Create or update a BGP community list
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Community Lists
Create or update a BGP community list
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Forwarding Table
Get forwarding table from tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/forwarding-table
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/forwarding-table
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Forwarding Table
Get forwarding table from tier-0 in CSV format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/forwarding-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/forwarding-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Read OSPF routing config
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Create or update a OSPF routing config
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Create or update a OSPF routing config
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
List OSPF area configurations
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/areas
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Delete OSPF Area config
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/areas/<area-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Read OSPF Area config
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/areas/<area-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Create or update a OSPF Area config
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/areas/<area-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Create or update a OSPF Area config
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/areas/<area-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Get OSPF database information
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/database
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Get OSPF Database information in CSV format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/database?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Get OSPF neighbor information
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/neighbors
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Get OSPF route information
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > OSPF
Get OSPF route information in CSV format
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ospf/routes?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
List prefix lists
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/prefix-lists
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Delete a prefix list
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Read a prefix list
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Create or patch a prefix list
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Prefix List
Create or update a prefix list
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
List route maps
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/route-maps
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Delete a route map
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Read a route map
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Create or update a route map
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Route Maps
Create or update a route map
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Routing Table
Get routing table from tier-0
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/routing-table
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/routing-table
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Routing Table
Get routing table from tier-0 in CSV format
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/routing-table?format=csv
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/routing-table?format=csv
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > State
Get Tier0 state
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/state
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/state
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
List Tier-0 Static Routes
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Delete Tier-0 static routes
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Read Tier-0 static routes
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/<route-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Create or update a Tier-0 static routes
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes
Create or update a Tier-0 static routes
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/<route-id>
PUT /policy/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
List StaticRouteBfdPeers
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/bfd-peers
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Delete this StaticRouteBfdPeer and all the entities contained by it.
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Read a StaticRouteBfdPeer
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Create or update a StaticRouteBfdPeer
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers
Create or update a StaticRouteBfdPeer
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
List Tier-0 Deployment maps
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Delete Tier-0 Deployment Map
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Read a Tier-0 Deployment Map
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Patch a Tier-0 Deployment Map under Tier-0
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Deployment Maps
Create a new Tier-0 Deployment Map under Tier-0
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/tier-0-deployment-maps/<tier-0-deployment-map-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
List Tier-0s
GET /policy/api/v1/global-infra/tier-0s
GET /policy/api/v1/infra/tier-0s
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Delete Tier-0
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Read Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Create or update a Tier-0
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Reprocess Tier0 gateway configuration and publish updates to NSX controller
POST /policy/api/v1/infra/tier-0s/<tier-0-id>?action=reprocess
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Gateways
Create or update a Tier-0
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
List Tier-0 locale-services
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Delete Tier-0 locale-services
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Read Tier-0 locale-services
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Create or update a tier-0 locale-services
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-0 Gateways > Tier-0 Locale Services
Create or update a Tier-0 locale-services
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > ARP Proxies
Get Tier-1 Address Resolution Protocol Proxies
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/arp-proxies
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/arp-proxies
Policy > Networking > Connectivity > Tier-1 Gateways > ARP Proxies
Get Tier-1 Address Resolution Protocol Proxies in CSV format
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/arp-proxies?format=csv
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/arp-proxies?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > ARP Proxies
Get Tier-1 Address Resolution Protocol Proxies
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/arp-proxies (Deprecated)
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/arp-proxies (Deprecated)
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Proxies
Get Tier-1 Interface Address Resolution Protocol Proxies in CSV format
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Proxies
Get Tier-1 Interface Address Resolution Protocol Proxies
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-proxy
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from tier-1 interface
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from tier-1 interface in CSV format
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table?format=csv
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink) in CSV format
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from segment interface (downlink)
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-1 router
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-arp-table (Deprecated)
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-arp-table (Deprecated)
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table for downlink router port on tier-1 router in CSV
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-arp-table?format=csv (Deprecated)
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-arp-table?format=csv (Deprecated)
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get ARP table from tier-1 router link interface in CSV format
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/tier-0-interface/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/tier-0-interface/arp-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table
Get tier-1 router link arp information
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/tier-0-interface/arp-table
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/tier-0-interface/arp-table
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > DAD State
Get DAD state for downlink router port on tier-1 router
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-dad-state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-dad-state
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
List Tier 1 Service Interfaces
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Delete Tier 1 service interface
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Read Tier 1 service interface
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create or update a Tier-1 service interface
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create a Tier1 service interface
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
List Tier-1 interfaces
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Delete Tier-1 interface
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Read Tier-1 interface
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create or update a Tier-1 interface
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Interfaces
Create or update a tier-1 interface
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get tier-1 interface statistics information
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get tier-1 interface statistics summary information
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-1 router
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-statistics
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get statistics for downlink router port on tier-1 router
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-statistics/summary
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/gateway-interface-statistics/summary
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get tier-1 router link statistics information
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/tier-0-interface/statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/tier-0-interface/statistics
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > Statistics
Get tier-1 router link statistics summary information
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/tier-0-interface/statistics/summary
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/tier-0-interface/statistics/summary
Policy > Networking > Connectivity > Tier-1 Gateways > Multicast
Read Multicast Configuration
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/multicast
Policy > Networking > Connectivity > Tier-1 Gateways > Multicast
Create or update multicast configuration
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/multicast
Policy > Networking > Connectivity > Tier-1 Gateways > Multicast
Create or update multicast configuration
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/multicast
Policy > Networking > Connectivity > Tier-1 Gateways > Multicast
Get Multicast Forwarding In Csv Format
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/multicast/forwarding?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Multicast
Get Multicast Forwarding
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/multicast/forwarding
Policy > Networking > Connectivity > Tier-1 Gateways > Multicast
Get IGMP Memberships in CSV format
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/multicast/igmp-memberships?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Multicast
Get IGMP Memberships
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/multicast/igmp-memberships
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Forwarding Table
Get forwarding table from tier-1 in CSV format
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/forwarding-table?format=csv
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/forwarding-table?format=csv
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Forwarding Table
Get forwarding table from tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/forwarding-table
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/forwarding-table
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > State
Get Tier1 state
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/state
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
List Tier-1 Static Routes
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/static-routes
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Delete Tier-1 static routes
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Read Tier-1 static routes
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes/<route-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Create or update a Tier-1 static routes
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Routing > Static Routes
Create or update a Tier-1 static routes
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/static-routes/<route-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
List Tier-1 instances
GET /policy/api/v1/global-infra/tier-1s
GET /policy/api/v1/infra/tier-1s
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Delete Tier-1 configuration
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Read Tier-1 configuration
GET /policy/api/v1/infra/tier-1s/<tier-1-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Create or update Tier-1 configuration
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Reprocess Tier1 gateway configuration and publish updates to NSX controller
POST /policy/api/v1/infra/tier-1s/<tier-1-id>?action=reprocess
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Gateways
Create or update tier-1 configuration
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
List Tier-1 locale-services
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Delete Tier-1 locale-services
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Read Tier-1 locale-services
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Create or update a Tier-1 locale-services
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Tier-1 Gateways > Tier-1 Locale Services
Create or update a Tier-1 locale-services
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>
Policy > Networking > Connectivity > Transport Zones
List Transport Zones under an Enforcement Point
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones
Policy > Networking > Connectivity > Transport Zones
Delete a Transport Zone under an Enforcement Point
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<transport-zone-id>
Policy > Networking > Connectivity > Transport Zones
Read a Transport Zone under an Enforcement Point
GET /policy/api/v1/global-infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<transport-zone-id>
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<transport-zone-id>
Policy > Networking > Connectivity > Transport Zones
Patch a Transport Zone under an Enforcement Point
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<transport-zone-id>
Policy > Networking > Connectivity > Transport Zones
PUT a Transport Zone under an Enforcement Point
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<transport-zone-id>
Policy > Networking > IP Management > DHCP > DHCP Leases
Delete DHCP lease(s) specified by IP and MAC
POST /policy/api/v1/infra/segments/<segment-id>?action=delete_dhcp_leases
Policy > Networking > IP Management > DHCP > DHCP Leases
Delete DHCP lease(s) specified by IP and MAC
POST /policy/api/v1/infra/tier-1s/<tier1-id>/segments/<segment-id>?action=delete_dhcp_leases
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
List DHCP relay config instances
GET /policy/api/v1/global-infra/dhcp-relay-configs
GET /policy/api/v1/infra/dhcp-relay-configs
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Delete DHCP relay configuration
DELETE /policy/api/v1/infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Read DHCP relay configuration
GET /policy/api/v1/infra/dhcp-relay-configs/<dhcp-relay-config-id>
GET /policy/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Create or update DHCP relay configuration
PATCH /policy/api/v1/infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Relay Configs
Create or update DHCP relay configuration
PUT /policy/api/v1/infra/dhcp-relay-configs/<dhcp-relay-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
List DHCP server config instances
GET /policy/api/v1/infra/dhcp-server-configs
GET /policy/api/v1/global-infra/dhcp-server-configs
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server leases
GET /policy/api/v1/global-infra/dhcp-server-configs/<config-id>/leases
GET /policy/api/v1/infra/dhcp-server-configs/<config-id>/leases
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server state
GET /policy/api/v1/global-infra/dhcp-server-configs/<config-id>/state
GET /policy/api/v1/infra/dhcp-server-configs/<config-id>/state
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server statistics
GET /policy/api/v1/infra/dhcp-server-configs/<config-id>/stats
GET /policy/api/v1/global-infra/dhcp-server-configs/<config-id>/stats
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server status
GET /policy/api/v1/infra/dhcp-server-configs/<config-id>/status
GET /policy/api/v1/global-infra/dhcp-server-configs/<config-id>/status
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Delete DHCP server configuration
DELETE /policy/api/v1/infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Read DHCP server configuration
GET /policy/api/v1/infra/dhcp-server-configs/<dhcp-server-config-id>
GET /policy/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Create or update DHCP server configuration
PATCH /policy/api/v1/infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Server Configs
Create or update DHCP server configuration
PUT /policy/api/v1/infra/dhcp-server-configs/<dhcp-server-config-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings
Read DHCP static binding state
GET /policy/api/v1/global-infra/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state
GET /policy/api/v1/infra/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state
Policy > Networking > IP Management > DHCP > DHCP Static Bindings
Read DHCP static binding state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
List all DHCP static bindings
GET /policy/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs
GET /policy/api/v1/infra/segments/<segment-id>/dhcp-static-binding-configs
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Delete DHCP static binding
DELETE /policy/api/v1/infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Read DHCP static binding
GET /policy/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
GET /policy/api/v1/infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Create or update DHCP static binding
PATCH /policy/api/v1/infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings
Create or update DHCP static binding
PUT /policy/api/v1/infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
List all DHCP static bindings
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Delete DHCP static binding
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Read DHCP static binding
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Create or update DHCP static binding
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DHCP > DHCP Static Bindings > Segments Bindings (Fixed)
Create or update DHCP static binding
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
List Dns Forwarder Zones
GET /policy/api/v1/global-infra/dns-forwarder-zones
GET /policy/api/v1/infra/dns-forwarder-zones
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Delete the DNS Forwarder Zone
DELETE /policy/api/v1/infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Read the DNS Forwarder Zone
GET /policy/api/v1/infra/dns-forwarder-zones/<dns-forwarder-zone-id>
GET /policy/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Create or update the DNS Forwarder Zone
PATCH /policy/api/v1/infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > DNS Zones
Create or update the DNS Forwarder Zone
PUT /policy/api/v1/infra/dns-forwarder-zones/<dns-forwarder-zone-id>
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Delete DNS configuration for tier-0 instance
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Read the DNS Forwarder for the given tier-0 instance
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Update the DNS Forwarder
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Perform the specified DNS forwarder action
POST /policy/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Update the DNS Forwarder
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Resolve a given address via the dns forwarder at Tier0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder/nslookup
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/nslookup
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Get tier-0 DNS forwarder statistics
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/statistics
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder/statistics
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-0 Gateways
Get current status of tier-0 DNS forwarder
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/dns-forwarder/status
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/status
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Delete DNS configuration for tier-1 instance
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Read the DNS Forwarder for the given tier-1 instance
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Create or update the DNS Forwarder
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Perform the specified DNS forwarder action
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder
POST /policy/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Create or update the DNS Forwarder
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Resolve a given address via the dns forwarder at Tier1
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/nslookup
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder/nslookup
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Get tier-1 DNS forwarder statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder/statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/statistics
Policy > Networking > IP Management > DNS > DNS Forwarder > Tier-1 Gateways
Get current status of tier-1 DNS forwarder
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/dns-forwarder/status
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/status
Policy > Networking > IP Management > IP Address Pools > IP Blocks
List IpAddressBlocks
GET /policy/api/v1/infra/ip-blocks
Policy > Networking > IP Management > IP Address Pools > IP Blocks
Delete an IpAddressBlock
DELETE /policy/api/v1/infra/ip-blocks/<ip-block-id>
Policy > Networking > IP Management > IP Address Pools > IP Blocks
Read a IpAddressBlock
GET /policy/api/v1/infra/ip-blocks/<ip-block-id>
Policy > Networking > IP Management > IP Address Pools > IP Blocks
Create a new IPBlock
PATCH /policy/api/v1/infra/ip-blocks/<ip-block-id>
Policy > Networking > IP Management > IP Address Pools > IP Blocks
Create or Replace IpAddressBlock
PUT /policy/api/v1/infra/ip-blocks/<ip-block-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
List IpAddressPools
GET /policy/api/v1/infra/ip-pools
Policy > Networking > IP Management > IP Address Pools > IP Pools
Delete an IpAddressPool
DELETE /policy/api/v1/infra/ip-pools/<ip-pool-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Read an IpAddressPool
GET /policy/api/v1/infra/ip-pools/<ip-pool-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Create a new IP address pool
PATCH /policy/api/v1/infra/ip-pools/<ip-pool-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Create or Replace IpAddressPool
PUT /policy/api/v1/infra/ip-pools/<ip-pool-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
List IpAddressPool Allocations
GET /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-allocations
Policy > Networking > IP Management > IP Address Pools > IP Pools
Records intent to release an IP from an IpPool.
DELETE /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-allocations/<ip-allocation-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Read policy IpPool allocation
GET /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-allocations/<ip-allocation-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Records intent to allocate an IP Address from an IP Pool
PATCH /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-allocations/<ip-allocation-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Records intent to allocate an IP Address from an IP Pool
PUT /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-allocations/<ip-allocation-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
List IpAddressPoolSubnets
GET /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-subnets
Policy > Networking > IP Management > IP Address Pools > IP Pools
Delete an IpAddressPoolSubnet
DELETE /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-subnets/<ip-subnet-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Read an IpAddressPoolSubnet
GET /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-subnets/<ip-subnet-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Create a new IP Subnet
PATCH /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-subnets/<ip-subnet-id>
Policy > Networking > IP Management > IP Address Pools > IP Pools
Create a new IP Subnet
PUT /policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-subnets/<ip-subnet-id>
Policy > Networking > IP Management > Manager IP Pools
List Manager Ip Pools
GET /policy/api/v1/infra/manager-ip-pools
Policy > Networking > IP Management > Manager IP Pools
Read a Manager Ip Pool
GET /policy/api/v1/infra/manager-ip-pools/<manager-ip-pool-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Analytics Profiles
List ALBAnalyticsProfile for infra
GET /policy/api/v1/infra/alb-analytics-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Analytics Profiles
Delete ALBAnalyticsProfile and all the entities contained by this ALBAnalyticsProfile
DELETE /policy/api/v1/infra/alb-analytics-profiles/<alb-analyticsprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Analytics Profiles
Read ALBAnalyticsProfile
GET /policy/api/v1/infra/alb-analytics-profiles/<alb-analyticsprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Analytics Profiles
Create or update a ALBanalyticsprofile
PATCH /policy/api/v1/infra/alb-analytics-profiles/<alb-analyticsprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Analytics Profiles
Create or update a ALBAnalyticsProfile
PUT /policy/api/v1/infra/alb-analytics-profiles/<alb-analyticsprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Persistence Profiles
List ALBApplicationPersistenceProfile for infra
GET /policy/api/v1/infra/alb-application-persistence-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Persistence Profiles
Delete ALBApplicationPersistenceProfile and all the entities contained by this ALBApplicationPersistenceProfile
DELETE /policy/api/v1/infra/alb-application-persistence-profiles/<alb-applicationpersistenceprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Persistence Profiles
Read ALBApplicationPersistenceProfile
GET /policy/api/v1/infra/alb-application-persistence-profiles/<alb-applicationpersistenceprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Persistence Profiles
Create or update a ALBapplicationpersistenceprofile
PATCH /policy/api/v1/infra/alb-application-persistence-profiles/<alb-applicationpersistenceprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Persistence Profiles
Create or update a ALBApplicationPersistenceProfile
PUT /policy/api/v1/infra/alb-application-persistence-profiles/<alb-applicationpersistenceprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Profiles
List ALBApplicationProfile for infra
GET /policy/api/v1/infra/alb-application-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Profiles
Delete ALBApplicationProfile and all the entities contained by this ALBApplicationProfile
DELETE /policy/api/v1/infra/alb-application-profiles/<alb-applicationprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Profiles
Read ALBApplicationProfile
GET /policy/api/v1/infra/alb-application-profiles/<alb-applicationprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Profiles
Create or update a ALBapplicationprofile
PATCH /policy/api/v1/infra/alb-application-profiles/<alb-applicationprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Application Profiles
Create or update a ALBApplicationProfile
PUT /policy/api/v1/infra/alb-application-profiles/<alb-applicationprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auth Profiles
List ALBAuthProfile for infra
GET /policy/api/v1/infra/alb-auth-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auth Profiles
Delete ALBAuthProfile and all the entities contained by this ALBAuthProfile
DELETE /policy/api/v1/infra/alb-auth-profiles/<alb-authprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auth Profiles
Read ALBAuthProfile
GET /policy/api/v1/infra/alb-auth-profiles/<alb-authprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auth Profiles
Create or update a ALBauthprofile
PATCH /policy/api/v1/infra/alb-auth-profiles/<alb-authprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auth Profiles
Create or update a ALBAuthProfile
PUT /policy/api/v1/infra/alb-auth-profiles/<alb-authprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auth Token
Alb Auth Token API calls to Avi Controller.
PUT /policy/api/v1/infra/alb-auth-token
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auto Scale Launch Configs
List ALBAutoScaleLaunchConfig for infra
GET /policy/api/v1/infra/alb-auto-scale-launch-configs
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auto Scale Launch Configs
Delete ALBAutoScaleLaunchConfig and all the entities contained by this ALBAutoScaleLaunchConfig
DELETE /policy/api/v1/infra/alb-auto-scale-launch-configs/<alb-autoscalelaunchconfig-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auto Scale Launch Configs
Read ALBAutoScaleLaunchConfig
GET /policy/api/v1/infra/alb-auto-scale-launch-configs/<alb-autoscalelaunchconfig-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auto Scale Launch Configs
Create or update a ALBautoscalelaunchconfig
PATCH /policy/api/v1/infra/alb-auto-scale-launch-configs/<alb-autoscalelaunchconfig-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Auto Scale Launch Configs
Create or update a ALBAutoScaleLaunchConfig
PUT /policy/api/v1/infra/alb-auto-scale-launch-configs/<alb-autoscalelaunchconfig-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Controller Version
Read an ALBControllerSupportedVersion
GET /policy/api/v1/infra/alb-controller-version
Policy > Networking > Network Services > Advanced Load Balancing > Alb DNS Policies
List ALBDnsPolicy for infra
GET /policy/api/v1/infra/alb-dns-policies
Policy > Networking > Network Services > Advanced Load Balancing > Alb DNS Policies
Delete ALBDnsPolicy and all the entities contained by this ALBDnsPolicy
DELETE /policy/api/v1/infra/alb-dns-policies/<alb-dnspolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb DNS Policies
Read ALBDnsPolicy
GET /policy/api/v1/infra/alb-dns-policies/<alb-dnspolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb DNS Policies
Create or update a ALBdnspolicy
PATCH /policy/api/v1/infra/alb-dns-policies/<alb-dnspolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb DNS Policies
Create or update a ALBDnsPolicy
PUT /policy/api/v1/infra/alb-dns-policies/<alb-dnspolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Bodies
List ALBErrorPageBody for infra
GET /policy/api/v1/infra/alb-error-page-bodies
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Bodies
Delete ALBErrorPageBody and all the entities contained by this ALBErrorPageBody
DELETE /policy/api/v1/infra/alb-error-page-bodies/<alb-errorpagebody-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Bodies
Read ALBErrorPageBody
GET /policy/api/v1/infra/alb-error-page-bodies/<alb-errorpagebody-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Bodies
Create or update a ALBerrorpagebody
PATCH /policy/api/v1/infra/alb-error-page-bodies/<alb-errorpagebody-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Bodies
Create or update a ALBErrorPageBody
PUT /policy/api/v1/infra/alb-error-page-bodies/<alb-errorpagebody-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Profiles
List ALBErrorPageProfile for infra
GET /policy/api/v1/infra/alb-error-page-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Profiles
Delete ALBErrorPageProfile and all the entities contained by this ALBErrorPageProfile
DELETE /policy/api/v1/infra/alb-error-page-profiles/<alb-errorpageprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Profiles
Read ALBErrorPageProfile
GET /policy/api/v1/infra/alb-error-page-profiles/<alb-errorpageprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Profiles
Create or update a ALBerrorpageprofile
PATCH /policy/api/v1/infra/alb-error-page-profiles/<alb-errorpageprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Error Page Profiles
Create or update a ALBErrorPageProfile
PUT /policy/api/v1/infra/alb-error-page-profiles/<alb-errorpageprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb HTTP Policy Sets
List ALBHTTPPolicySet for infra
GET /policy/api/v1/infra/alb-http-policy-sets
Policy > Networking > Network Services > Advanced Load Balancing > Alb HTTP Policy Sets
Delete ALBHTTPPolicySet and all the entities contained by this ALBHTTPPolicySet
DELETE /policy/api/v1/infra/alb-http-policy-sets/<alb-httppolicyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb HTTP Policy Sets
Read ALBHTTPPolicySet
GET /policy/api/v1/infra/alb-http-policy-sets/<alb-httppolicyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb HTTP Policy Sets
Create or update a ALBhttppolicyset
PATCH /policy/api/v1/infra/alb-http-policy-sets/<alb-httppolicyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb HTTP Policy Sets
Create or update a ALBHTTPPolicySet
PUT /policy/api/v1/infra/alb-http-policy-sets/<alb-httppolicyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Hardware Security Module Groups
List ALBHardwareSecurityModuleGroup for infra
GET /policy/api/v1/infra/alb-hardware-security-module-groups
Policy > Networking > Network Services > Advanced Load Balancing > Alb Hardware Security Module Groups
Delete ALBHardwareSecurityModuleGroup and all the entities contained by this ALBHardwareSecurityModuleGroup
DELETE /policy/api/v1/infra/alb-hardware-security-module-groups/<alb-hardwaresecuritymodulegroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Hardware Security Module Groups
Read ALBHardwareSecurityModuleGroup
GET /policy/api/v1/infra/alb-hardware-security-module-groups/<alb-hardwaresecuritymodulegroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Hardware Security Module Groups
Create or update a ALBhardwaresecuritymodulegroup
PATCH /policy/api/v1/infra/alb-hardware-security-module-groups/<alb-hardwaresecuritymodulegroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Hardware Security Module Groups
Create or update a ALBHardwareSecurityModuleGroup
PUT /policy/api/v1/infra/alb-hardware-security-module-groups/<alb-hardwaresecuritymodulegroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Health Monitors
List ALBHealthMonitor for infra
GET /policy/api/v1/infra/alb-health-monitors
Policy > Networking > Network Services > Advanced Load Balancing > Alb Health Monitors
Delete ALBHealthMonitor and all the entities contained by this ALBHealthMonitor
DELETE /policy/api/v1/infra/alb-health-monitors/<alb-healthmonitor-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Health Monitors
Read ALBHealthMonitor
GET /policy/api/v1/infra/alb-health-monitors/<alb-healthmonitor-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Health Monitors
Create or update a ALBhealthmonitor
PATCH /policy/api/v1/infra/alb-health-monitors/<alb-healthmonitor-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Health Monitors
Create or update a ALBHealthMonitor
PUT /policy/api/v1/infra/alb-health-monitors/<alb-healthmonitor-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb IP Addr Groups
List ALBIpAddrGroup for infra
GET /policy/api/v1/infra/alb-ip-addr-groups
Policy > Networking > Network Services > Advanced Load Balancing > Alb IP Addr Groups
Delete ALBIpAddrGroup and all the entities contained by this ALBIpAddrGroup
DELETE /policy/api/v1/infra/alb-ip-addr-groups/<alb-ipaddrgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb IP Addr Groups
Read ALBIpAddrGroup
GET /policy/api/v1/infra/alb-ip-addr-groups/<alb-ipaddrgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb IP Addr Groups
Create or update a ALBipaddrgroup
PATCH /policy/api/v1/infra/alb-ip-addr-groups/<alb-ipaddrgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb IP Addr Groups
Create or update a ALBIpAddrGroup
PUT /policy/api/v1/infra/alb-ip-addr-groups/<alb-ipaddrgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb L4 Policy Sets
List ALBL4PolicySet for infra
GET /policy/api/v1/infra/alb-l4-policy-sets
Policy > Networking > Network Services > Advanced Load Balancing > Alb L4 Policy Sets
Delete ALBL4PolicySet and all the entities contained by this ALBL4PolicySet
DELETE /policy/api/v1/infra/alb-l4-policy-sets/<alb-l4policyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb L4 Policy Sets
Read ALBL4PolicySet
GET /policy/api/v1/infra/alb-l4-policy-sets/<alb-l4policyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb L4 Policy Sets
Create or update a ALBl4policyset
PATCH /policy/api/v1/infra/alb-l4-policy-sets/<alb-l4policyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb L4 Policy Sets
Create or update a ALBL4PolicySet
PUT /policy/api/v1/infra/alb-l4-policy-sets/<alb-l4policyset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Profiles
List ALBNetworkProfile for infra
GET /policy/api/v1/infra/alb-network-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Profiles
Delete ALBNetworkProfile and all the entities contained by this ALBNetworkProfile
DELETE /policy/api/v1/infra/alb-network-profiles/<alb-networkprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Profiles
Read ALBNetworkProfile
GET /policy/api/v1/infra/alb-network-profiles/<alb-networkprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Profiles
Create or update a ALBnetworkprofile
PATCH /policy/api/v1/infra/alb-network-profiles/<alb-networkprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Profiles
Create or update a ALBNetworkProfile
PUT /policy/api/v1/infra/alb-network-profiles/<alb-networkprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Security Policies
List ALBNetworkSecurityPolicy for infra
GET /policy/api/v1/infra/alb-network-security-policies
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Security Policies
Delete ALBNetworkSecurityPolicy and all the entities contained by this ALBNetworkSecurityPolicy
DELETE /policy/api/v1/infra/alb-network-security-policies/<alb-networksecuritypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Security Policies
Read ALBNetworkSecurityPolicy
GET /policy/api/v1/infra/alb-network-security-policies/<alb-networksecuritypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Security Policies
Create or update a ALBnetworksecuritypolicy
PATCH /policy/api/v1/infra/alb-network-security-policies/<alb-networksecuritypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Network Security Policies
Create or update a ALBNetworkSecurityPolicy
PUT /policy/api/v1/infra/alb-network-security-policies/<alb-networksecuritypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Onboarding Workflow
This is Post Controller Deployment Workflow. It will create role if not exist Create Service User Set System Configuration Create Enforcement Point Save Infra-Admin Creds to DB.
PUT /policy/api/v1/infra/alb-onboarding-workflow
Policy > Networking > Network Services > Advanced Load Balancing > Alb Onboarding Workflow
Delete EnforcementPoint and the Infra Admin credentials contained by this workflow
DELETE /policy/api/v1/infra/alb-onboarding-workflow/<managed-by>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pki Profiles
List ALBPKIProfile for infra
GET /policy/api/v1/infra/alb-pki-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pki Profiles
Delete ALBPKIProfile and all the entities contained by this ALBPKIProfile
DELETE /policy/api/v1/infra/alb-pki-profiles/<alb-pkiprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pki Profiles
Read ALBPKIProfile
GET /policy/api/v1/infra/alb-pki-profiles/<alb-pkiprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pki Profiles
Create or update a ALBpkiprofile
PATCH /policy/api/v1/infra/alb-pki-profiles/<alb-pkiprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pki Profiles
Create or update a ALBPKIProfile
PUT /policy/api/v1/infra/alb-pki-profiles/<alb-pkiprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Group Deployment Policies
List ALBPoolGroupDeploymentPolicy for infra
GET /policy/api/v1/infra/alb-pool-group-deployment-policies
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Group Deployment Policies
Delete ALBPoolGroupDeploymentPolicy and all the entities contained by this ALBPoolGroupDeploymentPolicy
DELETE /policy/api/v1/infra/alb-pool-group-deployment-policies/<alb-poolgroupdeploymentpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Group Deployment Policies
Read ALBPoolGroupDeploymentPolicy
GET /policy/api/v1/infra/alb-pool-group-deployment-policies/<alb-poolgroupdeploymentpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Group Deployment Policies
Create or update a ALBpoolgroupdeploymentpolicy
PATCH /policy/api/v1/infra/alb-pool-group-deployment-policies/<alb-poolgroupdeploymentpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Group Deployment Policies
Create or update a ALBPoolGroupDeploymentPolicy
PUT /policy/api/v1/infra/alb-pool-group-deployment-policies/<alb-poolgroupdeploymentpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Groups
List ALBPoolGroup for infra
GET /policy/api/v1/infra/alb-pool-groups
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Groups
Delete ALBPoolGroup and all the entities contained by this ALBPoolGroup
DELETE /policy/api/v1/infra/alb-pool-groups/<alb-poolgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Groups
Read ALBPoolGroup
GET /policy/api/v1/infra/alb-pool-groups/<alb-poolgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Groups
Create or update a ALBpoolgroup
PATCH /policy/api/v1/infra/alb-pool-groups/<alb-poolgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pool Groups
Create or update a ALBPoolGroup
PUT /policy/api/v1/infra/alb-pool-groups/<alb-poolgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pools
List ALBPool for infra
GET /policy/api/v1/infra/alb-pools
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pools
Delete ALBPool and all the entities contained by this ALBPool
DELETE /policy/api/v1/infra/alb-pools/<alb-pool-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pools
Read ALBPool
GET /policy/api/v1/infra/alb-pools/<alb-pool-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pools
Create or update a ALBpool
PATCH /policy/api/v1/infra/alb-pools/<alb-pool-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Pools
Create or update a ALBPool
PUT /policy/api/v1/infra/alb-pools/<alb-pool-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Priority Labels
List ALBPriorityLabels for infra
GET /policy/api/v1/infra/alb-priority-labels
Policy > Networking > Network Services > Advanced Load Balancing > Alb Priority Labels
Delete ALBPriorityLabels and all the entities contained by this ALBPriorityLabels
DELETE /policy/api/v1/infra/alb-priority-labels/<alb-prioritylabels-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Priority Labels
Read ALBPriorityLabels
GET /policy/api/v1/infra/alb-priority-labels/<alb-prioritylabels-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Priority Labels
Create or update a ALBprioritylabels
PATCH /policy/api/v1/infra/alb-priority-labels/<alb-prioritylabels-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Priority Labels
Create or update a ALBPriorityLabels
PUT /policy/api/v1/infra/alb-priority-labels/<alb-prioritylabels-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Protocol Parsers
List ALBProtocolParser for infra
GET /policy/api/v1/infra/alb-protocol-parsers
Policy > Networking > Network Services > Advanced Load Balancing > Alb Protocol Parsers
Delete ALBProtocolParser and all the entities contained by this ALBProtocolParser
DELETE /policy/api/v1/infra/alb-protocol-parsers/<alb-protocolparser-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Protocol Parsers
Read ALBProtocolParser
GET /policy/api/v1/infra/alb-protocol-parsers/<alb-protocolparser-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Protocol Parsers
Create or update a ALBprotocolparser
PATCH /policy/api/v1/infra/alb-protocol-parsers/<alb-protocolparser-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Protocol Parsers
Create or update a ALBProtocolParser
PUT /policy/api/v1/infra/alb-protocol-parsers/<alb-protocolparser-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Key And Certificates
List ALBSSLKeyAndCertificate for infra
GET /policy/api/v1/infra/alb-ssl-key-and-certificates
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Key And Certificates
Delete ALBSSLKeyAndCertificate and all the entities contained by this ALBSSLKeyAndCertificate
DELETE /policy/api/v1/infra/alb-ssl-key-and-certificates/<alb-sslkeyandcertificate-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Key And Certificates
Read ALBSSLKeyAndCertificate
GET /policy/api/v1/infra/alb-ssl-key-and-certificates/<alb-sslkeyandcertificate-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Key And Certificates
Create or update a ALBsslkeyandcertificate
PATCH /policy/api/v1/infra/alb-ssl-key-and-certificates/<alb-sslkeyandcertificate-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Key And Certificates
Create or update a ALBSSLKeyAndCertificate
PUT /policy/api/v1/infra/alb-ssl-key-and-certificates/<alb-sslkeyandcertificate-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Profiles
List ALBSSLProfile for infra
GET /policy/api/v1/infra/alb-ssl-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Profiles
Delete ALBSSLProfile and all the entities contained by this ALBSSLProfile
DELETE /policy/api/v1/infra/alb-ssl-profiles/<alb-sslprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Profiles
Read ALBSSLProfile
GET /policy/api/v1/infra/alb-ssl-profiles/<alb-sslprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Profiles
Create or update a ALBsslprofile
PATCH /policy/api/v1/infra/alb-ssl-profiles/<alb-sslprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb SSL Profiles
Create or update a ALBSSLProfile
PUT /policy/api/v1/infra/alb-ssl-profiles/<alb-sslprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Security Policies
List ALBSecurityPolicy for infra
GET /policy/api/v1/infra/alb-security-policies
Policy > Networking > Network Services > Advanced Load Balancing > Alb Security Policies
Delete ALBSecurityPolicy and all the entities contained by this ALBSecurityPolicy
DELETE /policy/api/v1/infra/alb-security-policies/<alb-securitypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Security Policies
Read ALBSecurityPolicy
GET /policy/api/v1/infra/alb-security-policies/<alb-securitypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Security Policies
Create or update a ALBsecuritypolicy
PATCH /policy/api/v1/infra/alb-security-policies/<alb-securitypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Security Policies
Create or update a ALBSecurityPolicy
PUT /policy/api/v1/infra/alb-security-policies/<alb-securitypolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Server Auto Scale Policies
List ALBServerAutoScalePolicy for infra
GET /policy/api/v1/infra/alb-server-auto-scale-policies
Policy > Networking > Network Services > Advanced Load Balancing > Alb Server Auto Scale Policies
Delete ALBServerAutoScalePolicy and all the entities contained by this ALBServerAutoScalePolicy
DELETE /policy/api/v1/infra/alb-server-auto-scale-policies/<alb-serverautoscalepolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Server Auto Scale Policies
Read ALBServerAutoScalePolicy
GET /policy/api/v1/infra/alb-server-auto-scale-policies/<alb-serverautoscalepolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Server Auto Scale Policies
Create or update a ALBserverautoscalepolicy
PATCH /policy/api/v1/infra/alb-server-auto-scale-policies/<alb-serverautoscalepolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Server Auto Scale Policies
Create or update a ALBServerAutoScalePolicy
PUT /policy/api/v1/infra/alb-server-auto-scale-policies/<alb-serverautoscalepolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Sso Policies
List ALBSSOPolicy for infra
GET /policy/api/v1/infra/alb-sso-policies
Policy > Networking > Network Services > Advanced Load Balancing > Alb Sso Policies
Delete ALBSSOPolicy and all the entities contained by this ALBSSOPolicy
DELETE /policy/api/v1/infra/alb-sso-policies/<alb-ssopolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Sso Policies
Read ALBSSOPolicy
GET /policy/api/v1/infra/alb-sso-policies/<alb-ssopolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Sso Policies
Create or update a ALBssopolicy
PATCH /policy/api/v1/infra/alb-sso-policies/<alb-ssopolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Sso Policies
Create or update a ALBSSOPolicy
PUT /policy/api/v1/infra/alb-sso-policies/<alb-ssopolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb String Groups
List ALBStringGroup for infra
GET /policy/api/v1/infra/alb-string-groups
Policy > Networking > Network Services > Advanced Load Balancing > Alb String Groups
Delete ALBStringGroup and all the entities contained by this ALBStringGroup
DELETE /policy/api/v1/infra/alb-string-groups/<alb-stringgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb String Groups
Read ALBStringGroup
GET /policy/api/v1/infra/alb-string-groups/<alb-stringgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb String Groups
Create or update a ALBstringgroup
PATCH /policy/api/v1/infra/alb-string-groups/<alb-stringgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb String Groups
Create or update a ALBStringGroup
PUT /policy/api/v1/infra/alb-string-groups/<alb-stringgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Traffic Clone Profiles
List ALBTrafficCloneProfile for infra
GET /policy/api/v1/infra/alb-traffic-clone-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Traffic Clone Profiles
Delete ALBTrafficCloneProfile and all the entities contained by this ALBTrafficCloneProfile
DELETE /policy/api/v1/infra/alb-traffic-clone-profiles/<alb-trafficcloneprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Traffic Clone Profiles
Read ALBTrafficCloneProfile
GET /policy/api/v1/infra/alb-traffic-clone-profiles/<alb-trafficcloneprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Traffic Clone Profiles
Create or update a ALBtrafficcloneprofile
PATCH /policy/api/v1/infra/alb-traffic-clone-profiles/<alb-trafficcloneprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Traffic Clone Profiles
Create or update a ALBTrafficCloneProfile
PUT /policy/api/v1/infra/alb-traffic-clone-profiles/<alb-trafficcloneprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Virtual Services
List ALBVirtualService for infra
GET /policy/api/v1/infra/alb-virtual-services
Policy > Networking > Network Services > Advanced Load Balancing > Alb Virtual Services
Delete ALBVirtualService and all the entities contained by this ALBVirtualService
DELETE /policy/api/v1/infra/alb-virtual-services/<alb-virtualservice-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Virtual Services
Read ALBVirtualService
GET /policy/api/v1/infra/alb-virtual-services/<alb-virtualservice-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Virtual Services
Create or update a ALBvirtualservice
PATCH /policy/api/v1/infra/alb-virtual-services/<alb-virtualservice-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Virtual Services
Create or update a ALBVirtualService
PUT /policy/api/v1/infra/alb-virtual-services/<alb-virtualservice-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Data Script Sets
List ALBVSDataScriptSet for infra
GET /policy/api/v1/infra/alb-vs-data-script-sets
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Data Script Sets
Delete ALBVSDataScriptSet and all the entities contained by this ALBVSDataScriptSet
DELETE /policy/api/v1/infra/alb-vs-data-script-sets/<alb-vsdatascriptset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Data Script Sets
Read ALBVSDataScriptSet
GET /policy/api/v1/infra/alb-vs-data-script-sets/<alb-vsdatascriptset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Data Script Sets
Create or update a ALBvsdatascriptset
PATCH /policy/api/v1/infra/alb-vs-data-script-sets/<alb-vsdatascriptset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Data Script Sets
Create or update a ALBVSDataScriptSet
PUT /policy/api/v1/infra/alb-vs-data-script-sets/<alb-vsdatascriptset-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Vips
List ALBVsVip for infra
GET /policy/api/v1/infra/alb-vs-vips
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Vips
Delete ALBVsVip and all the entities contained by this ALBVsVip
DELETE /policy/api/v1/infra/alb-vs-vips/<alb-vsvip-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Vips
Read ALBVsVip
GET /policy/api/v1/infra/alb-vs-vips/<alb-vsvip-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Vips
Create or update a ALBvsvip
PATCH /policy/api/v1/infra/alb-vs-vips/<alb-vsvip-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Vs Vips
Create or update a ALBVsVip
PUT /policy/api/v1/infra/alb-vs-vips/<alb-vsvip-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Crs
List ALBWafCRS for infra
GET /policy/api/v1/infra/alb-waf-crs
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Crs
Delete ALBWafCRS and all the entities contained by this ALBWafCRS
DELETE /policy/api/v1/infra/alb-waf-crs/<alb-wafcrs-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Crs
Read ALBWafCRS
GET /policy/api/v1/infra/alb-waf-crs/<alb-wafcrs-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Crs
Create or update a ALBwafcrs
PATCH /policy/api/v1/infra/alb-waf-crs/<alb-wafcrs-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Crs
Create or update a ALBWafCRS
PUT /policy/api/v1/infra/alb-waf-crs/<alb-wafcrs-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policies
List ALBWafPolicy for infra
GET /policy/api/v1/infra/alb-waf-policies
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policies
Delete ALBWafPolicy and all the entities contained by this ALBWafPolicy
DELETE /policy/api/v1/infra/alb-waf-policies/<alb-wafpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policies
Read ALBWafPolicy
GET /policy/api/v1/infra/alb-waf-policies/<alb-wafpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policies
Create or update a ALBwafpolicy
PATCH /policy/api/v1/infra/alb-waf-policies/<alb-wafpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policies
Create or update a ALBWafPolicy
PUT /policy/api/v1/infra/alb-waf-policies/<alb-wafpolicy-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policy Psm Groups
List ALBWafPolicyPSMGroup for infra
GET /policy/api/v1/infra/alb-waf-policy-psm-groups
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policy Psm Groups
Delete ALBWafPolicyPSMGroup and all the entities contained by this ALBWafPolicyPSMGroup
DELETE /policy/api/v1/infra/alb-waf-policy-psm-groups/<alb-wafpolicypsmgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policy Psm Groups
Read ALBWafPolicyPSMGroup
GET /policy/api/v1/infra/alb-waf-policy-psm-groups/<alb-wafpolicypsmgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policy Psm Groups
Create or update a ALBwafpolicypsmgroup
PATCH /policy/api/v1/infra/alb-waf-policy-psm-groups/<alb-wafpolicypsmgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Policy Psm Groups
Create or update a ALBWafPolicyPSMGroup
PUT /policy/api/v1/infra/alb-waf-policy-psm-groups/<alb-wafpolicypsmgroup-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Profiles
List ALBWafProfile for infra
GET /policy/api/v1/infra/alb-waf-profiles
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Profiles
Delete ALBWafProfile and all the entities contained by this ALBWafProfile
DELETE /policy/api/v1/infra/alb-waf-profiles/<alb-wafprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Profiles
Read ALBWafProfile
GET /policy/api/v1/infra/alb-waf-profiles/<alb-wafprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Profiles
Create or update a ALBwafprofile
PATCH /policy/api/v1/infra/alb-waf-profiles/<alb-wafprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Waf Profiles
Create or update a ALBWafProfile
PUT /policy/api/v1/infra/alb-waf-profiles/<alb-wafprofile-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Webhooks
List ALBWebhook for infra
GET /policy/api/v1/infra/alb-webhooks
Policy > Networking > Network Services > Advanced Load Balancing > Alb Webhooks
Delete ALBWebhook and all the entities contained by this ALBWebhook
DELETE /policy/api/v1/infra/alb-webhooks/<alb-webhook-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Webhooks
Read ALBWebhook
GET /policy/api/v1/infra/alb-webhooks/<alb-webhook-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Webhooks
Create or update a ALBwebhook
PATCH /policy/api/v1/infra/alb-webhooks/<alb-webhook-id>
Policy > Networking > Network Services > Advanced Load Balancing > Alb Webhooks
Create or update a ALBWebhook
PUT /policy/api/v1/infra/alb-webhooks/<alb-webhook-id>
Policy > Networking > Network Services > Forwarding Policies
List forwarding policies for the given domain
GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies
GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies
Policy > Networking > Network Services > Forwarding Policies
Delete forwarding policy
DELETE /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Policy > Networking > Network Services > Forwarding Policies
Read forwarding policy
GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Policy > Networking > Network Services > Forwarding Policies
Create or update forwarding policy
PATCH /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Policy > Networking > Network Services > Forwarding Policies
Create or update forwarding policy
PUT /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>
Policy > Networking > Network Services > Forwarding Policies
List rules
GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules
GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules
Policy > Networking > Network Services > Forwarding Policies
Delete ForwardingRule
DELETE /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Policy > Networking > Network Services > Forwarding Policies
Read rule
GET /policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Policy > Networking > Network Services > Forwarding Policies
Update forwarding rule
PATCH /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Policy > Networking > Network Services > Forwarding Policies
Update forwarding rule
PUT /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>
Policy > Networking > Network Services > Forwarding Policies > Rules > Statistics
Get forwarding rule statistics.
GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<forwarding-rule-id>/statistics
Policy > Networking > Network Services > Forwarding Policies > Rules > Statistics
Reset Forwarding rule statistics
POST /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/stats?action=reset
Policy > Networking > Network Services > Forwarding Policies > Statistics
Get forwarding policy statistics.
GET /policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/statistics
Policy > Networking > Network Services > Load Balancing > Load Balancer Pools
List LBPools
GET /policy/api/v1/infra/lb-pools
Policy > Networking > Network Services > Load Balancing > Load Balancer Pools
Delete LBPool and all the entities contained by this LBPool
DELETE /policy/api/v1/infra/lb-pools/<lb-pool-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Pools
Read LBPool
GET /policy/api/v1/infra/lb-pools/<lb-pool-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Pools
Create or update a LBPool
PATCH /policy/api/v1/infra/lb-pools/<lb-pool-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Pools
Create or update a LBPool
PUT /policy/api/v1/infra/lb-pools/<lb-pool-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Application Profiles
List LBAppProfiles
GET /policy/api/v1/infra/lb-app-profiles
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Application Profiles
Delete LBAppProfile and all the entities contained by this LBAppProfile
DELETE /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Application Profiles
Read LBAppProfile
GET /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Application Profiles
Create or update a LBAppProfile
PATCH /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Application Profiles
Create or update a LBAppProfile
PUT /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Monitor Profiles
List LBMonitorProfiles for infra
GET /policy/api/v1/infra/lb-monitor-profiles (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Monitor Profiles
Delete LBMonitorProfile and all the entities contained by this LBMonitorProfile
DELETE /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Monitor Profiles
Read LBMonitorProfile
GET /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Monitor Profiles
Create or update a LBMonitorProfile
PATCH /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Monitor Profiles
Create or update a LBMonitorProfile
PUT /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Persistence Profiles
List LBPersistenceProfiles for infra
GET /policy/api/v1/infra/lb-persistence-profiles
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Persistence Profiles
Delete LBPersistenceProfile and all the entities contained by this LBPersistenceProfile
DELETE /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Persistence Profiles
Read LBPersistenceProfile
GET /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Persistence Profiles
Create or update a LBPersistenceProfile
PATCH /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer Persistence Profiles
Create or update a LBPersistenceProfile
PUT /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Client SSL Profiles
List LBClientSslProfiles
GET /policy/api/v1/infra/lb-client-ssl-profiles (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Client SSL Profiles
Delete LBClientSslProfile and all the entities contained by this LBClientSslProfile
DELETE /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Client SSL Profiles
Read LBClientSslProfile
GET /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Client SSL Profiles
Create or update a LBClientSslProfile
PATCH /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Client SSL Profiles
Create or update a LBClientSslProfile
PUT /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer SSL Ciphers And Protocols
Retrieve a list of supported SSL ciphers and protocols
GET /policy/api/v1/infra/lb-ssl-ciphers-and-protocols (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Server SSL Profiles
List LBServerSslProfiles
GET /policy/api/v1/infra/lb-server-ssl-profiles (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Server SSL Profiles
Delete LBServerSslProfile and all the entities contained by this LBServerSslProfile
DELETE /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Server SSL Profiles
Read LBServerSslProfile
GET /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Server SSL Profiles
Create or update a LBServerSslProfile
PATCH /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Profiles > Load Balancer SSL Profiles > Load Balancer Server SSL Profiles
Create or update a LBServerSslProfile
PUT /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id> (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Services
List LBService
GET /policy/api/v1/infra/lb-services
Policy > Networking > Network Services > Load Balancing > Load Balancer Services
Delete LBService and all the entities contained by this LBService
DELETE /policy/api/v1/infra/lb-services/<lb-service-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Services
Read LBService
GET /policy/api/v1/infra/lb-services/<lb-service-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Services
Create or update a LBVirtualServer
PATCH /policy/api/v1/infra/lb-services/<lb-service-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Services
Create or update a LBService
PUT /policy/api/v1/infra/lb-services/<lb-service-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Statistics
Get LBPool statistics information
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/statistics
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Statistics
Get LBVirtualServer statistics information
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/statistics
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Statistics
Get LBService statistics information
GET /policy/api/v1/infra/lb-services/<lb-service-id>/statistics
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Status
Get LBService status information
GET /policy/api/v1/infra/lb-services/<lb-service-id>/detailed-status
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Status
Get LBPool status information
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/detailed-status
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Status
Get LBVirtualServer status information
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/detailed-status
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Usage
Read load balancer usage for the given node
GET /policy/api/v1/infra/lb-node-usage (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Usage
Read load balancer node usage summary
GET /policy/api/v1/infra/lb-node-usage-summary (Deprecated)
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Usage
Read load balancer service usage summary
GET /policy/api/v1/infra/lb-service-usage-summary
Policy > Networking > Network Services > Load Balancing > Load Balancer Usage > Usage
Get LBService usage information
GET /policy/api/v1/infra/lb-services/<lb-service-id>/service-usage
Policy > Networking > Network Services > Load Balancing > Load Balancer Virtual Servers
List LBVirtualServers
GET /policy/api/v1/infra/lb-virtual-servers
Policy > Networking > Network Services > Load Balancing > Load Balancer Virtual Servers
Delete LBVirtualServer and all the entities contained by this LBVirtualServer.
DELETE /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Virtual Servers
Read LBVirtualServer
GET /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Virtual Servers
Create or update a LBVirtualServer
PATCH /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>
Policy > Networking > Network Services > Load Balancing > Load Balancer Virtual Servers
Create or update a LBVirtualServer
PUT /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>
Policy > Networking > Network Services > Metadata Proxy
List Metadata Proxy Configurations
GET /policy/api/v1/infra/metadata-proxies
Policy > Networking > Network Services > Metadata Proxy
Delete Metadata Proxy Config
DELETE /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>
Policy > Networking > Network Services > Metadata Proxy
Get Metadata Proxy Config
GET /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>
Policy > Networking > Network Services > Metadata Proxy
Create or update Metadata Proxy Config
PATCH /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>
Policy > Networking > Network Services > Metadata Proxy
Create or update Metadata Proxy Config
PUT /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>
Policy > Networking > Network Services > Metadata Proxy > Status
Get metadata proxy status
GET /policy/api/v1/global-infra/metadata-proxies/<metadata-proxy-id>/statistics
GET /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>/statistics
Policy > Networking > Network Services > Metadata Proxy > Status
Get metadata proxy status
GET /policy/api/v1/infra/metadata-proxies/<metadata-proxy-id>/status
GET /policy/api/v1/global-infra/metadata-proxies/<metadata-proxy-id>/status
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
List Policy NAT types.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
List NAT Rules
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Delete NAT Rule
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Get NAT Rule
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Create or update a NAT Rule on tier-0
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-0 Gateways
Update NAT Rule
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
List Policy NAT types.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
List NAT Rules
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Delete NAT Rule
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Get NAT Rule
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Create or update a Nat Rule
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Rules > Tier-1 Gateways
Update NAT Rule
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>
Policy > Networking > Network Services > NAT > Statistics
Get NAT Rule Statistics
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
Policy > Networking > Network Services > NAT > Statistics
List NAT Rules Statistics
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/statistics
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/statistics
Policy > Networking > Network Services > NAT > Statistics
Get NAT Rule Statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics
Policy > Networking > Network Services > NAT > Statistics
List NAT Rules Statistics
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/statistics
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/statistics
Policy > Networking > Network Services > VPN > IPSEC > DPD Profiles
List DPD profiles
GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles
Policy > Networking > Network Services > VPN > IPSEC > DPD Profiles
Delete custom dead peer detection (DPD) profile
DELETE /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > DPD Profiles
Get dead peer detection (DPD) profile
GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > DPD Profiles
Create or patch a custom DPD Profile
PATCH /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > DPD Profiles
Create or fully replace a custom IPSec tunnel Profile
PUT /policy/api/v1/infra/ipsec-vpn-dpd-profiles/<dpd-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IKE Profiles
List IKE profiles
GET /policy/api/v1/infra/ipsec-vpn-ike-profiles
Policy > Networking > Network Services > VPN > IPSEC > IKE Profiles
Delete custom IKE Profile
DELETE /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IKE Profiles
Get IKE Profile
GET /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IKE Profiles
Create or patch a custom internet key exchange (IKE) Profile
PATCH /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IKE Profiles
Create or fully replace a custom internet key exchange (IKE) Profile
PUT /policy/api/v1/infra/ipsec-vpn-ike-profiles/<ike-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IPSEC Profiles
List IPSec tunnel profiles
GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles
Policy > Networking > Network Services > VPN > IPSEC > IPSEC Profiles
Delete custom IPSec tunnel Profile
DELETE /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IPSEC Profiles
Get IPSec tunnel Profile
GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IPSEC Profiles
Create or patch a custom IPSec tunnel Profile
PATCH /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > IPSEC Profiles
Create or fully replace a custom IPSec tunnel Profile
PUT /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/<tunnel-profile-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint list result
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Delete IPSec VPN local endpoint
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or patch a custom IPSec VPN local endpoint
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or fully replace IPSec VPN local endpoint
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint list result
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Delete IPSec VPN local endpoint
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or patch a custom IPSec VPN local endpoint
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or fully replace IPSec VPN local endpoint
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint list result
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Delete IPSec VPN local endpoint
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or patch a custom IPSec VPN local endpoint
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or fully replace IPSec VPN local endpoint
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint list result
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Delete IPSec VPN local endpoint
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Get IPSec VPN local endpoint
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or patch a custom IPSec VPN local endpoint
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints
Create or fully replace IPSec VPN local endpoint
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service list result
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services
Policy > Networking > Network Services > VPN > IPSEC > Services
Delete IPSec VPN service
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or patch IPSec VPN service
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or fully replace IPSec VPN service
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service list result
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Delete IPSec VPN service
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or patch IPSec VPN service
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or fully replace IPSec VPN service
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service list result
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services
Policy > Networking > Network Services > VPN > IPSEC > Services
Delete IPSec VPN service
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or patch IPSec VPN service
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or fully replace IPSec VPN service
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service list result
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Delete IPSec VPN service
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Get IPSec VPN service
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or patch IPSec VPN service
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Services
Create or fully replace IPSec VPN service
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN sessions list result
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Delete IPSec VPN session
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or patch an IPSec VPN session
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or fully replace IPSec VPN session
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN configuration for the peer site
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN sessions list result
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Delete IPSec VPN session
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or patch an IPSec VPN session
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or fully replace IPSec VPN session
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN configuration for the peer site
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN sessions list result
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Delete IPSec VPN session
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or patch an IPSec VPN session
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or fully replace IPSec VPN session
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN configuration for the peer site
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN sessions list result
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Delete IPSec VPN session
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN Session
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or patch an IPSec VPN session
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Create or fully replace IPSec VPN session
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions
Get IPSec VPN configuration for the peer site
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions > Summary
Get IPSec VPN Session Summary
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/summary
Policy > Networking > Network Services > VPN > IPSEC > Sessions > Summary
Get IPSec VPN Session Summary
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/summary (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Sessions > Summary
Get IPSec VPN Session Summary
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/summary
Policy > Networking > Network Services > VPN > IPSEC > Sessions > Summary
Get IPSec VPN Session Summary
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/summary (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Get IPSec VPN session statistics under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Reset the statistics of the given VPN session
POST /policy/api/v1/global-infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Get IPSec VPN session statistics under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Reset the statistics of the given VPN session
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Get IPSec VPN session statistics under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Reset the statistics of the given VPN session
POST /policy/api/v1/global-infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Get IPSec VPN session statistics under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Statistics
Reset the statistics of the given VPN session
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Status
Get IPSec VPN session detailed status under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Status
Get IPSec VPN session detailed status under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)
Policy > Networking > Network Services > VPN > IPSEC > Status
Get IPSec VPN session detailed status under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status
Policy > Networking > Network Services > VPN > IPSEC > Status
Get IPSec VPN session detailed status under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Remote-Mac
Get L2Vpn session remote mac for logical switch
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac
Policy > Networking > Network Services > VPN > L2VPN > Remote-Mac
Get L2Vpn session remote mac for logical switch
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Remote-Mac
Get L2Vpn session remote mac for logical switch
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac
Policy > Networking > Network Services > VPN > L2VPN > Remote-Mac
Get L2Vpn session remote mac for logical switch
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/remote-mac (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service list result under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services
Policy > Networking > Network Services > VPN > L2VPN > Services
Delete L2VPN service under Tier-0
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or patch L2VPN service under Tier-0
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or fully replace L2VPN service under Tier-0
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service list result under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Delete L2VPN service under Tier-0
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or patch L2VPN service under Tier-0
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or fully replace L2VPN service under Tier-0
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service list result under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services
Policy > Networking > Network Services > VPN > L2VPN > Services
Delete L2VPN service under Tier-1
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or patch L2VPN service under Tier-1
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or fully replace L2VPN service under Tier-1
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service list result under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Delete L2VPN service under Tier-1
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Get L2VPN service under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or patch L2VPN service under Tier-1
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Services
Create or fully replace L2VPN service under Tier-1
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN sessions list result under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Delete L2VPN session under Tier-0
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN Session under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-0
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-0 from Peer Codes
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or fully replace L2VPN session under Tier-0
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get Tier-0 L2VPN session configuration for the peer site
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN sessions list result under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Delete L2VPN session under Tier-0
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN Session under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-0
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-0 from Peer Codes
POST /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or fully replace L2VPN session under Tier-0
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get Tier-0 L2VPN session configuration for the peer site
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN sessions list result under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Delete L2VPN session under Tier-1
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN Session under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-1
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-1 from Peer Codes
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or fully replace L2VPN session under Tier-1
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get Tier-1 L2VPN session configuration for the peer site
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN sessions list result under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Delete L2VPN session under Tier-1
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get L2VPN Session under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-1
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or patch an L2VPN session under Tier-1 from Peer Codes
POST /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Create or fully replace L2VPN session under Tier-1
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id> (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Sessions
Get Tier-1 L2VPN session configuration for the peer site
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/peer-config (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Statistics
Get L2VPN session statistics under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics
Policy > Networking > Network Services > VPN > L2VPN > Statistics
Get L2VPN session statistics under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Statistics
Get L2VPN session statistics under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics
Policy > Networking > Network Services > VPN > L2VPN > Statistics
Get L2VPN session statistics under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/statistics (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Status
Get L2VPN session detailed status under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status
Policy > Networking > Network Services > VPN > L2VPN > Status
Get L2VPN session detailed status under Tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)
Policy > Networking > Network Services > VPN > L2VPN > Status
Get L2VPN session detailed status under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status
Policy > Networking > Network Services > VPN > L2VPN > Status
Get L2VPN session detailed status under Tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/l2vpn-services/<service-id>/sessions/<session-id>/detailed-status (Deprecated)
Policy > Networking > Networking Profiles > BFD Profiles
List BfdProfiles
GET /policy/api/v1/infra/bfd-profiles
GET /policy/api/v1/global-infra/bfd-profiles
Policy > Networking > Networking Profiles > BFD Profiles
Delete BFD Config and all the entities contained by this BfdProfile
DELETE /policy/api/v1/infra/bfd-profiles/<bfd-profile-id>
DELETE /policy/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > BFD Profiles
Read a BfdProfile
GET /policy/api/v1/infra/bfd-profiles/<bfd-profile-id>
GET /policy/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > BFD Profiles
Create or update a BfdProfile
PATCH /policy/api/v1/infra/bfd-profiles/<bfd-profile-id>
PATCH /policy/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > BFD Profiles
Create or update a BfdProfile
PUT /policy/api/v1/infra/bfd-profiles/<bfd-profile-id>
PUT /policy/api/v1/global-infra/bfd-profiles/<bfd-profile-id>
Policy > Networking > Networking Profiles > EVPN Tenant Configuration
List Evpn Tenant Configuration
GET /policy/api/v1/infra/evpn-tenant-configs
Policy > Networking > Networking Profiles > EVPN Tenant Configuration
Read Evpn Tenant Configuration
GET /policy/api/v1/infra/evpn-tenant-configs/<config-id>
Policy > Networking > Networking Profiles > EVPN Tenant Configuration
Create or Update Evpn Tenant Configuration
PATCH /policy/api/v1/infra/evpn-tenant-configs/<config-id>
Policy > Networking > Networking Profiles > EVPN Tenant Configuration
Create or Update Evpn Tenant Configuration
PUT /policy/api/v1/infra/evpn-tenant-configs/<config-id>
Policy > Networking > Networking Profiles > EVPN VNI Pools
List Vni Pool Configuration
GET /policy/api/v1/infra/vni-pools
Policy > Networking > Networking Profiles > EVPN VNI Pools
Delete Vni Pool Configuration
DELETE /policy/api/v1/infra/vni-pools/<vni-pool-id>
Policy > Networking > Networking Profiles > EVPN VNI Pools
Read Vni Pool Configuration
GET /policy/api/v1/infra/vni-pools/<vni-pool-id>
Policy > Networking > Networking Profiles > EVPN VNI Pools
Create or Update Vni Pool Configuration
PATCH /policy/api/v1/infra/vni-pools/<vni-pool-id>
Policy > Networking > Networking Profiles > EVPN VNI Pools
Create or Update Vni Pool Configuration
PUT /policy/api/v1/infra/vni-pools/<vni-pool-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
List all gateway QoS profiles
GET /policy/api/v1/global-infra/gateway-qos-profiles
GET /policy/api/v1/infra/gateway-qos-profiles
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Delete gateway QoS profile
DELETE /policy/api/v1/infra/gateway-qos-profiles/<qos-profile-id>
DELETE /policy/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Read gateway QoS profile
GET /policy/api/v1/infra/gateway-qos-profiles/<qos-profile-id>
GET /policy/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Create or update Gateway QoS profile
PATCH /policy/api/v1/infra/gateway-qos-profiles/<qos-profile-id>
PATCH /policy/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > Gateway QOS Profiles
Create or update Gateway QoS profile
PUT /policy/api/v1/infra/gateway-qos-profiles/<qos-profile-id>
PUT /policy/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>
Policy > Networking > Networking Profiles > Global Gateway Configuration
Read the connectivity global configuration
GET /policy/api/v1/infra/connectivity-global-config
Policy > Networking > Networking Profiles > Global Gateway Configuration
Update the connectivity global configuration
PATCH /policy/api/v1/infra/connectivity-global-config
Policy > Networking > Networking Profiles > Global Gateway Configuration
Update the connectivity global configuration
PUT /policy/api/v1/infra/connectivity-global-config
Policy > Networking > Networking Profiles > Global Gateway Configuration
Read global configuration
GET /policy/api/v1/infra/global-config
Policy > Networking > Networking Profiles > Global Gateway Configuration
Update the global configuration
PATCH /policy/api/v1/infra/global-config (Deprecated)
Policy > Networking > Networking Profiles > Global Gateway Configuration
Update the global configuration
PUT /policy/api/v1/infra/global-config
Policy > Networking > Networking Profiles > Global Gateway Configuration
Read global Operations Configuration
GET /policy/api/v1/infra/ops-global-config
Policy > Networking > Networking Profiles > Global Gateway Configuration
Update the global Operationconfiguration
PATCH /policy/api/v1/infra/ops-global-config
Policy > Networking > Networking Profiles > Global Gateway Configuration
Update the global Operations Configuration
PUT /policy/api/v1/infra/ops-global-config
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
List all IPv6 DAD profiles
GET /policy/api/v1/infra/ipv6-dad-profiles
GET /policy/api/v1/global-infra/ipv6-dad-profiles
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Delete IPv6 DAD profile
DELETE /policy/api/v1/infra/ipv6-dad-profiles/<dad-profile-id>
DELETE /policy/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Read IPv6 DAD profile
GET /policy/api/v1/infra/ipv6-dad-profiles/<dad-profile-id>
GET /policy/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Create or update IPv6 DAD profile
PATCH /policy/api/v1/infra/ipv6-dad-profiles/<dad-profile-id>
PATCH /policy/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 DAD Profiles
Create or update IPv6 DAD profile
PUT /policy/api/v1/infra/ipv6-dad-profiles/<dad-profile-id>
PUT /policy/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
List all IPv6 NDRA profiles
GET /policy/api/v1/infra/ipv6-ndra-profiles
GET /policy/api/v1/global-infra/ipv6-ndra-profiles
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Delete IPv6 NDRA profile
DELETE /policy/api/v1/infra/ipv6-ndra-profiles/<ndra-profile-id>
DELETE /policy/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Read IPv6 NDRA profile
GET /policy/api/v1/infra/ipv6-ndra-profiles/<ndra-profile-id>
GET /policy/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Create or update IPv6 NDRA profile
PATCH /policy/api/v1/infra/ipv6-ndra-profiles/<ndra-profile-id>
PATCH /policy/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Networking > Networking Profiles > IPV6 NDRA Profiles
Create or update IPv6 NDRA profile
PUT /policy/api/v1/infra/ipv6-ndra-profiles/<ndra-profile-id>
PUT /policy/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>
Policy > Networking > Networking Profiles > Multicast Profiles
List Igmp Profile
GET /policy/api/v1/infra/igmp-profiles
Policy > Networking > Networking Profiles > Multicast Profiles
Delete Igmp Profile
DELETE /policy/api/v1/infra/igmp-profiles/<igmp-profile-id>
Policy > Networking > Networking Profiles > Multicast Profiles
Read Igmp Profile
GET /policy/api/v1/infra/igmp-profiles/<igmp-profile-id>
Policy > Networking > Networking Profiles > Multicast Profiles
Update igmp profile
PATCH /policy/api/v1/infra/igmp-profiles/<igmp-profile-id>
Policy > Networking > Networking Profiles > Multicast Profiles
Update igmp profile
PUT /policy/api/v1/infra/igmp-profiles/<igmp-profile-id>
Policy > Networking > Networking Profiles > Multicast Profiles
List Pim Profile
GET /policy/api/v1/infra/pim-profiles
Policy > Networking > Networking Profiles > Multicast Profiles
Read Pim Profile
GET /policy/api/v1/infra/pim-profiles/<pim-profile-id>
Policy > Networking > Networking Profiles > Multicast Profiles
Update pim profile
PATCH /policy/api/v1/infra/pim-profiles/<pim-profile-id>
Policy > Networking > Networking Profiles > Multicast Profiles
Update pim profile
PUT /policy/api/v1/infra/pim-profiles/<pim-profile-id>
Policy > Networking > Networking Profiles > Transport Zone Profiles
List Policy Transport Zone Profiles
GET /policy/api/v1/infra/transport-zone-profiles
GET /policy/api/v1/global-infra/transport-zone-profiles
Policy > Networking > Networking Profiles > Transport Zone Profiles
Delete Policy Transport Zone Profile
DELETE /policy/api/v1/infra/transport-zone-profiles/<tz-profile-id>
Policy > Networking > Networking Profiles > Transport Zone Profiles
Get Policy Transport Zone Profile
GET /policy/api/v1/global-infra/transport-zone-profiles/<tz-profile-id>
GET /policy/api/v1/infra/transport-zone-profiles/<tz-profile-id>
Policy > Networking > Networking Profiles > Transport Zone Profiles
Create Policy Transport Zone Profile
PATCH /policy/api/v1/infra/transport-zone-profiles/<tz-profile-id>
Policy > Networking > Networking Profiles > Transport Zone Profiles
Update Policy Transport Zone Profile
PUT /policy/api/v1/infra/transport-zone-profiles/<tz-profile-id>
Policy > Security
Get policies filtered based on the given criteria
GET /policy/api/v1/global-infra/firewall/policies
GET /policy/api/v1/infra/firewall/policies
Policy > Security
Get rules filtered based on the given criteria
GET /policy/api/v1/global-infra/firewall/rules
GET /policy/api/v1/infra/firewall/rules
Policy > Security > East West Security > Distributed Firewall > Communication Maps
List communication maps
GET /policy/api/v1/infra/domains/<domain-id>/communication-maps (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Deletes a communication map from this domain
DELETE /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Read communication-map
GET /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Patch communication map
PATCH /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Revise the positioning of communication maps
POST /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id>?action=revise (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Create or Update communication map
PUT /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
List CommunicationEntries
GET /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id>/communication-entries (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Delete CommunicationEntry
DELETE /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id>/communication-entries/<communication-entry-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Read CommunicationEntry
GET /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id>/communication-entries/<communication-entry-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Patch a CommunicationEntry
PATCH /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id>/communication-entries/<communication-entry-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Revise the positioning of communication entry
POST /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id>/communication-entries/<communication-entry-id>?action=revise (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Communication Maps
Create or update a CommunicationEntry
PUT /policy/api/v1/infra/domains/<domain-id>/communication-maps/<communication-map-id>/communication-entries/<communication-entry-id> (Deprecated)
Policy > Security > East West Security > Distributed Firewall > Container Cluster
List all container cluster span of a security policy
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/container-cluster-span
Policy > Security > East West Security > Distributed Firewall > Container Cluster
Deletes a security policy from this domain
DELETE /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/container-cluster-span/<antrea-cluster-1>
Policy > Security > East West Security > Distributed Firewall > Container Cluster
Read container cluster for a security policy
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/container-cluster-span/<antrea-cluster-1>
Policy > Security > East West Security > Distributed Firewall > Container Cluster
Add a container cluster as a span of this security policy
PATCH /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/container-cluster-span/<container-cluster-id>
Policy > Security > East West Security > Distributed Firewall > Container Cluster
Add a container cluster as a span of this security policy
PUT /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/container-cluster-span/<container-cluster-id>
Policy > Security > East West Security > Distributed Firewall > Rules
List security policies
GET /policy/api/v1/infra/domains/<domain-id>/security-policies
GET /policy/api/v1/global-infra/domains/<domain-id>/security-policies
Policy > Security > East West Security > Distributed Firewall > Rules
Deletes a security policy from this domain
DELETE /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Read security policy
GET /policy/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Patch security policy
PATCH /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Revise the positioning of security policies
POST /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>?action=revise
Policy > Security > East West Security > Distributed Firewall > Rules
Create or Update security policy
PUT /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>
Policy > Security > East West Security > Distributed Firewall > Rules
List rules
GET /policy/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/rules
Policy > Security > East West Security > Distributed Firewall > Rules
Delete rule
DELETE /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Read rule
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
GET /policy/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Patch a rule
PATCH /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Rules
Revise the positioning of rule
POST /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>?action=revise
Policy > Security > East West Security > Distributed Firewall > Rules
Create or update a rule
PUT /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed Firewall > Settings
Get the list of distributed firewall dependent services
GET /policy/api/v1/infra/settings/firewall/security/dependent-services
Policy > Security > East West Security > Distributed Firewall > Settings > Distributed Firewall Settings
Get dfw firewall configuration
GET /policy/api/v1/infra/settings/firewall/security
Policy > Security > East West Security > Distributed Firewall > Settings > Distributed Firewall Settings
Update dfw firewall configuration
PATCH /policy/api/v1/infra/settings/firewall/security
Policy > Security > East West Security > Distributed Firewall > Settings > Distributed Firewall Settings
Update dfw firewall configuration
PUT /policy/api/v1/infra/settings/firewall/security
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
List policy drafts
GET /policy/api/v1/infra/drafts
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Delete a manual draft
DELETE /policy/api/v1/infra/drafts/<draft-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Read draft
GET /policy/api/v1/infra/drafts/<draft-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Patch a manual draft
PATCH /policy/api/v1/infra/drafts/<draft-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Publish a draft
POST /policy/api/v1/infra/drafts/<draft-id>?action=publish
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Create or update a manual draft
PUT /policy/api/v1/infra/drafts/<draft-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Get an aggregated configuration for the draft
GET /policy/api/v1/infra/drafts/<draft-id>/aggregated
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Get paginated aggregated configuration for the draft
GET /policy/api/v1/infra/drafts/<draft-id>/aggregated_with_pagination
Policy > Security > East West Security > Distributed Firewall > Settings > Drafts
Get a preview of a configuration after publish of a draft
GET /policy/api/v1/infra/drafts/<draft-id>/complete
Policy > Security > East West Security > Distributed Firewall > Settings > Exclusion List
Read security policy exclude list including system and user excluded members
GET /policy/api/v1/infra/settings/firewall/security/exclude-list?system_owned=true
Policy > Security > East West Security > Distributed Firewall > Settings > Exclusion List
Read security policy exclude list
GET /policy/api/v1/infra/settings/firewall/security/exclude-list
Policy > Security > East West Security > Distributed Firewall > Settings > Exclusion List
Patch exclusion list for security policy
PATCH /policy/api/v1/infra/settings/firewall/security/exclude-list
Policy > Security > East West Security > Distributed Firewall > Settings > Exclusion List
Filter the firewall exclude list
POST /policy/api/v1/infra/settings/firewall/security/exclude-list?action=filter
Policy > Security > East West Security > Distributed Firewall > Settings > Exclusion List
Create or update exclusion list for security policy
PUT /policy/api/v1/infra/settings/firewall/security/exclude-list
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Scan the size of a directory domain
POST /policy/api/v1/infra/firewall-identity-store-size
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
List all firewall identity stores
GET /policy/api/v1/infra/firewall-identity-stores
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Fetch all organization units for a LDAP server.
POST /policy/api/v1/infra/firewall-identity-stores-org-units
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Delete firewall identity store
DELETE /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Read firewall identity store
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Create or update a firewall identity store
PATCH /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Invoke full sync or delta sync for a specific domain, with additional delay in seconds if needed. Stop sync will try to stop any pending sync if any to return to idle state.
POST /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Create or update a firewall identity store
PUT /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Fetch all organization units for a Firewall Identity Store.
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/org-units
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get Firewall identity store sync statistics for the given identifier
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/sync-stats
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get IDFW status for a Compute Collection
GET /policy/api/v1/infra/settings/firewall/idfw/compute-collections/<compute-collection-id>/status
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
List IDFW status for Transport Nodes in a Compute Collection
GET /policy/api/v1/infra/settings/firewall/idfw/compute-collections/<compute-collection-id>/transport-nodes/status
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get IDFW status for all Compute Collections
GET /policy/api/v1/infra/settings/firewall/idfw/compute-collections/status
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get all IDFW Group VM details for a given Group
GET /policy/api/v1/infra/settings/firewall/idfw/group-vm-details
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get IDFW system statistics data
GET /policy/api/v1/infra/settings/firewall/idfw/system-stats
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
List IDFW status of VMs by transport node id
GET /policy/api/v1/infra/settings/firewall/idfw/transport-nodes/<transport-node-id>/vms/status
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get user session data
GET /policy/api/v1/infra/settings/firewall/idfw/user-session-data
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get IDFW user login events for a given user
GET /policy/api/v1/infra/settings/firewall/idfw/user-stats/<user-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store
Get IDFW user login events for a given VM
GET /policy/api/v1/infra/settings/firewall/idfw/vm-stats/<vm-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server
Delete a Event Log server for Firewall Identity store
DELETE /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/event-log-servers/<event-log-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server
Get a specific Event Log server for a given Firewall Identity store
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/event-log-servers/<event-log-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server
Update a event log server for Firewall Identity store
PUT /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/event-log-servers/<event-log-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Groups
Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/groups
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Groups
List members of a directory group
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/groups/<group-id>/member-groups
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > LDAP Servers
Test a directory domain event log server connectivity
POST /policy/api/v1/infra/firewall-identity-store-event-log-servers/status
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > LDAP Servers
Test a directory domain LDAP server connectivity
POST /policy/api/v1/infra/firewall-identity-store-ldap-server
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > LDAP Servers
Test a LDAP server connection for directory domain
POST /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server
List all configured domain LDAP servers
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/ldap-servers
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server
Delete a LDAP server for Firewall Identity store
DELETE /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server
Get a specific LDAP server for a given Firewall Identity store
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server
Create a LDAP server for Firewall Identity store
PATCH /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server
Update a LDAP server for Firewall Identity store
PUT /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Get PolicyFirewallSchedulers
GET /policy/api/v1/infra/firewall-schedulers
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Delete Policy Firewall Scheduler
DELETE /policy/api/v1/infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Get PolicyFirewallScheduler
GET /policy/api/v1/infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Create or Update PolicyFirewallScheduler
PATCH /policy/api/v1/infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Scheduler
Create or Update PolicyFirewallScheduler
PUT /policy/api/v1/infra/firewall-schedulers/<firewall-scheduler-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
List compute cluster idfw Configuration
GET /policy/api/v1/infra/settings/firewall/idfw/cluster
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Delete compute cluster idfw configuration
DELETE /policy/api/v1/infra/settings/firewall/idfw/cluster/<cluster-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Read compute cluster idfw configuration
GET /policy/api/v1/infra/settings/firewall/idfw/cluster/<cluster-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Patch compute cluster idfw configuration
PATCH /policy/api/v1/infra/settings/firewall/idfw/cluster/<cluster-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Create or update compute cluster idfw configuration
PUT /policy/api/v1/infra/settings/firewall/idfw/cluster/<cluster-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Read idfw configuration for standalone host
GET /policy/api/v1/infra/settings/firewall/idfw/standalone-host-switch-setting
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Patch idfw configuration for standalone host
PATCH /policy/api/v1/infra/settings/firewall/idfw/standalone-host-switch-setting
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Create or update idfw configuration for standalone host
PUT /policy/api/v1/infra/settings/firewall/idfw/standalone-host-switch-setting
Policy > Security > East West Security > Distributed Firewall > Settings > Identity Firewall Settings
Post User Login/Logout events for IDFW
POST /policy/api/v1/system/input/login-logout-events
Policy > Security > East West Security > Distributed Firewall > Statistics
Get rule statistics
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>/statistics
GET /policy/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/rules/<rule-id>/statistics
Policy > Security > East West Security > Distributed Firewall > Statistics
Get security policy statistics
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>/statistics
GET /policy/api/v1/global-infra/domains/<domain-id>/security-policies/<security-policy-id>/statistics
Policy > Security > East West Security > Distributed Firewall > Statistics
Reset firewall rule statistics
POST /policy/api/v1/infra/settings/firewall/stats?action=reset
POST /policy/api/v1/global-infra/settings/firewall/stats?action=reset
Policy > Security > East West Security > Distributed Firewall > Task
Download exported file
GET /policy/api/v1/infra/settings/firewall/export?action=download
Policy > Security > East West Security > Distributed Firewall > Task
Get the information of export task
GET /policy/api/v1/infra/settings/firewall/export
Policy > Security > East West Security > Distributed Firewall > Task
Cancel a running export task
POST /policy/api/v1/infra/settings/firewall/export?action=cancel
Policy > Security > East West Security > Distributed Firewall > Task
Invoke export task
POST /policy/api/v1/infra/settings/firewall/export
Policy > Security > East West Security > Distributed Firewall > Task
Get the information of import task
GET /policy/api/v1/infra/settings/firewall/import
Policy > Security > East West Security > Distributed Firewall > Task
Invoke import task
POST /policy/api/v1/infra/settings/firewall/import
Policy > Security > East West Security > Distributed Firewall > Task
Cancel a running import task
POST /policy/api/v1/infra/settings/firewall/import?action=cancel
Policy > Security > East West Security > Distributed IDS > Dashboard
Get the list of the IPs affected for that signature for intrusion events detected on gateway
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/affected-ips
Policy > Security > East West Security > Distributed IDS > Dashboard
Get the list of the users affected for that signature
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/affected-users
Policy > Security > East West Security > Distributed IDS > Dashboard
Get the list of the VMs affected for that signature
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/affected-vms
Policy > Security > East West Security > Distributed IDS > Dashboard
Get the list of the IDS events that are detected, grouped by signature id.
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-events
Policy > Security > East West Security > Distributed IDS > Dashboard
Get the summary of the intrusions that were detected.
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-summary
Policy > Security > East West Security > Distributed IDS > Intrusion Services
Get IDS system settings
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services
Policy > Security > East West Security > Distributed IDS > Intrusion Services
Patch Intrusion detection system settings
PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services
Policy > Security > East West Security > Distributed IDS > Intrusion Services
Update Intrusion detection system settings
PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services
Policy > Security > East West Security > Distributed IDS > Profiles
List IDS profiles
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles
Policy > Security > East West Security > Distributed IDS > Profiles
Delete IDS profile
DELETE /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
Get IDS profile.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
Patch IDS profile
PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
create or update IDS profile
PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
Get IDS profile signatures.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/profiles/<profile-id>/effective-signatures (Experimental)
Policy > Security > East West Security > Distributed IDS > Profiles
List Malware Prevention profiles
GET /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles
Policy > Security > East West Security > Distributed IDS > Profiles
Delete Malware Prevention profile
DELETE /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
Get Malware Prevention profile.
GET /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
Patch Malware Prevention profile
PATCH /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
Patch Malware Prevention profile
PUT /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/profiles/<profile-id>
Policy > Security > East West Security > Distributed IDS > Profiles
List Malware Prevention signatures
GET /policy/api/v1/infra/settings/firewall/security/malware-prevention-service/signatures
Policy > Security > East West Security > Distributed IDS > Rules
List IDS security policies
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies
Policy > Security > East West Security > Distributed IDS > Rules
Delete IDS security policy
DELETE /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>
Policy > Security > East West Security > Distributed IDS > Rules
Get IDS security policy.
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>
Policy > Security > East West Security > Distributed IDS > Rules
Patch IDS security policy
PATCH /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>
Policy > Security > East West Security > Distributed IDS > Rules
Revise the positioning of IDS security policies
POST /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>?action=revise
Policy > Security > East West Security > Distributed IDS > Rules
create or update IDS security policy
PUT /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>
Policy > Security > East West Security > Distributed IDS > Rules
List IDS rules
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>/rules
Policy > Security > East West Security > Distributed IDS > Rules
Delete IDS rule
DELETE /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed IDS > Rules
Get IDS rule.
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed IDS > Rules
Patch IDS rule
PATCH /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed IDS > Rules
Revise the positioning of IDS rule
POST /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>/rules/<rule-id>?action=revise
Policy > Security > East West Security > Distributed IDS > Rules
create or update IDS rule
PUT /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<policy-id>/rules/<rule-id>
Policy > Security > East West Security > Distributed IDS > Rules > Statistics
Get IDS/IPS rule statistics
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<ids-policy-id>/rules/<rule-id>/statistics
Policy > Security > East West Security > Distributed IDS > Rules > Statistics
Reset IDS/IPS rule statistics
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/stats?action=reset
Policy > Security > East West Security > Distributed IDS > Settings > Enablement
List IDS cluster configs
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs
Policy > Security > East West Security > Distributed IDS > Settings > Enablement
Read IDS cluster config.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs/<cluster-config-id>
Policy > Security > East West Security > Distributed IDS > Settings > Enablement
Patch IDS config on cluster level
PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs/<cluster-config-id>
Policy > Security > East West Security > Distributed IDS > Settings > Enablement
create or update IDS config on cluster level
PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/cluster-configs/<cluster-config-id>
Policy > Security > East West Security > Distributed IDS > Settings > Enablement
Read IDS config
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config
Policy > Security > East West Security > Distributed IDS > Settings > Enablement
Patch IDS configuration
PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config
Policy > Security > East West Security > Distributed IDS > Settings > Enablement
Create or update IDS configuration
PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/ids-standalone-host-config
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
List Global IDS signatures
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Delete Global IDS signature
DELETE /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/<signature-id>
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Get Global IDS signature.
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/<signature-id>
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Patch Global IDS Signature
PATCH /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/<signature-id>
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
create or update Global IDS Signature
PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services/global-signatures/<signature-id>
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Get IDS signature versions
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/signature-versions
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Change the state of IDS Signature Version
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/signature-versions?action=make_active_version
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
List IDS signatures
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/signature-versions/<version-id>/signatures
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Download and update IDS signatures
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/signatures?action=update_signatures
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Upload IDS signatures bundle
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/signatures?action=upload_signatures
Policy > Security > East West Security > Distributed IDS > Settings > Signatures
Get IDS signature status
GET /policy/api/v1/infra/settings/firewall/security/intrusion-services/signatures/status
Policy > Security > East West Security > Distributed IDS > Statistics
Get IDS security policy statistics
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-policies/<ids-policy-id>/statistics
Policy > Security > Endpoint Protection > Rules
Delete Endpoint policy
DELETE /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>
Policy > Security > Endpoint Protection > Rules
Read Endpoint policy
GET /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>
Policy > Security > Endpoint Protection > Rules
Create or update Endpoint policy
PATCH /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>
Policy > Security > Endpoint Protection > Rules
Create or update Endpoint policy
PUT /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>
Policy > Security > Endpoint Protection > Rules
List Endpoint rules
GET /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>/endpoint-rules
Policy > Security > Endpoint Protection > Rules
Delete EndpointRule
DELETE /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>/endpoint-rules/<endpoint-rule-id>
Policy > Security > Endpoint Protection > Rules
Read Endpoint rule
GET /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>/endpoint-rules/<endpoint-rule-id>
Policy > Security > Endpoint Protection > Rules
Update Endpoint rule
PATCH /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>/endpoint-rules/<endpoint-rule-id>
Policy > Security > Endpoint Protection > Rules
Update Endpoint rule
PUT /policy/api/v1/infra/domains/<domain-id>/endpoint-policies/<endpoint-policy-id>/endpoint-rules/<endpoint-rule-id>
Policy > Security > Endpoint Protection > Rules
List Endpoint policies
GET /policy/api/v1/infra/domains/endpoint-policies
Policy > Security > North South Security > Gateway Firewall > Rules
List gateway policies
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies
Policy > Security > North South Security > Gateway Firewall > Rules
Delete GatewayPolicy
DELETE /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Read gateway policy
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway policy
PATCH /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Revise the positioning of gateway policy
POST /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>?action=revise
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway policy
PUT /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
Policy > Security > North South Security > Gateway Firewall > Rules
List rules
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules
Policy > Security > North South Security > Gateway Firewall > Rules
Delete rule
DELETE /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Read rule
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway rule
PATCH /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Rules
Revise the positioning of gateway rule
POST /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>?action=revise
Policy > Security > North South Security > Gateway Firewall > Rules
Update gateway rule
PUT /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Settings > Firewall Configuration
Get the list of gateway firewall dependent services
GET /policy/api/v1/infra/settings/firewall/gateway/dependent-services
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Delete security config
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/security-config
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Read Security Feature
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/security-config
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Create or Update security configuration
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/security-config
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Create or Update security configuration
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/security-config
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Read Security Feature
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/security-config
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Create or Update security configuration
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/security-config
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Create or Update security configuration
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/security-config
Policy > Security > North South Security > Gateway Firewall > Statistics
Get gateway rule statistics
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>/statistics
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>/statistics
Policy > Security > North South Security > Gateway Firewall > Statistics
Get gateway policy statistics
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/statistics
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/statistics
Policy > Security > North South Security > Gateway Firewall > Tier-0 Gateways
Get list of gateway policies with rules that belong to the specific Tier-0 logical router.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/gateway-firewall
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/gateway-firewall
Policy > Security > North South Security > Gateway Firewall > Tier-0 Gateways
Get list of gateway policies with rules that belong to the specific Tier-0 LocalServices.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/gateway-firewall
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/gateway-firewall
Policy > Security > North South Security > Gateway Firewall > Tier-1 Gateways
Get list of gateway policies with rules that belong to the specific Tier-1.
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/gateway-firewall
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/gateway-firewall
Policy > Security > North South Security > Gateway Firewall > Tier-1 Gateways
Get list of gateway policies with rules that belong to the specific Tier-1 LocalServices.
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/gateway-firewall
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/gateway-firewall
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
List TLS Config Profiles
GET /policy/api/v1/infra/security/tls-inspection-config-profiles (Experimental)
GET /policy/api/v1/global-infra/security/tls-inspection-config-profiles (Experimental)
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Delete TLS Config Profile
DELETE /policy/api/v1/infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
DELETE /policy/api/v1/global-infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Get TLS Config Profile
GET /policy/api/v1/infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
GET /policy/api/v1/global-infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Create or update TLS Config Profile
PATCH /policy/api/v1/infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
PATCH /policy/api/v1/global-infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Update TLS Config Profile
PUT /policy/api/v1/infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
PUT /policy/api/v1/global-infra/security/tls-inspection-config-profiles/<tls-inspection-config-profile> (Experimental)
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Delete TLS Config Profile Binding for Tier-1 Logical Router
DELETE /policy/api/v1/infra/tier-1s/<tier1-id>/tls-inspection-config-profile-bindings/<tls-inspection-config-profile-binding-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Get TLS Config Profile Binding Map for Tier-1 Logical Router
GET /policy/api/v1/global-infra/tier-1s/<tier1-id>/tls-inspection-config-profile-bindings/<tls-inspection-config-profile-binding-id>
GET /policy/api/v1/infra/tier-1s/<tier1-id>/tls-inspection-config-profile-bindings/<tls-inspection-config-profile-binding-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Create or update TLS Config Profile Binding Map for Tier-1 Logical Router
PATCH /policy/api/v1/infra/tier-1s/<tier1-id>/tls-inspection-config-profile-bindings/<tls-inspection-config-profile-binding-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Config
Create or update TLS Config Profile Binding Map for Tier-1 Logical Router
PUT /policy/api/v1/infra/tier-1s/<tier1-id>/tls-inspection-config-profile-bindings/<tls-inspection-config-profile-binding-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Profiles
Get Tls profiles available.
GET /policy/api/v1/infra/tls-inspection-action-profiles
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Profiles
Delete a Tls profile.
DELETE /policy/api/v1/infra/tls-inspection-action-profiles/<action-profile-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Profiles
Get TLS profile with id.
GET /policy/api/v1/infra/tls-inspection-action-profiles/<action-profile-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Profiles
Create a Tls profile.
PATCH /policy/api/v1/infra/tls-inspection-action-profiles/<action-profile-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Profiles
Update a Tls profile.
PUT /policy/api/v1/infra/tls-inspection-action-profiles/<action-profile-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
List TLS policies
GET /policy/api/v1/infra/tls-inspection-policies
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Delete TlsPolicy
DELETE /policy/api/v1/infra/tls-inspection-policies/<policy-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Read tls policy
GET /policy/api/v1/infra/tls-inspection-policies/<policy-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Update TLS policy
PATCH /policy/api/v1/infra/tls-inspection-policies/<policy-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Update TLS policy
PUT /policy/api/v1/infra/tls-inspection-policies/<policy-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
List TLS rules
GET /policy/api/v1/infra/tls-inspection-policies/<policy-id>/rules
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Delete rule
DELETE /policy/api/v1/infra/tls-inspection-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Read rule
GET /policy/api/v1/infra/tls-inspection-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Update TLS rule
PATCH /policy/api/v1/infra/tls-inspection-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls Rules
Update TLS rule
PUT /policy/api/v1/infra/tls-inspection-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls State
TLS inspection execution state details for the tier1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/tls-inspection-state
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls State
TLS inspection execution state fqdn details for the tier1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/tls-inspection-state/fqdns
Policy > Security > North South Security > Gateway Firewall > Tls Inspection > Tls State
Get TLS inspection FQDN state
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/tls-inspection-state/fqdns/<fqdn-id>
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Delete FqdnAnalysisConfig
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/fqdn-analysis-config
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Get FqdnAnalysisConfig
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/fqdn-analysis-config
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Create or Update FqdnAnalysisConfig
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/fqdn-analysis-config
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Create or Update FqdnAnalysisConfig
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/fqdn-analysis-config
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Delete PolicyUrlCategorizationConfig
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Get PolicyUrlCategorizationConfig
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Create or Update PolicyUrlCategorizationConfig
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Create or Update PolicyUrlCategorizationConfig
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Get the list of URL categories.
GET /policy/api/v1/infra/url-categories
Policy > Security > North South Security > Gateway Firewall > Url Categorization
Get the list of reputation severity
GET /policy/api/v1/infra/url-reputation-severities
Policy > Security > North South Security > Gateway IDS > Rules
List IDS gateway policies
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies
Policy > Security > North South Security > Gateway IDS > Rules
Delete IDS GatewayPolicy
DELETE /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>
Policy > Security > North South Security > Gateway IDS > Rules
Read IDS gateway policy
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>
Policy > Security > North South Security > Gateway IDS > Rules
Update IDS gateway policy
PATCH /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>
Policy > Security > North South Security > Gateway IDS > Rules
Revise the positioning of IDS gateway policy
POST /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>?action=revise
Policy > Security > North South Security > Gateway IDS > Rules
Update IDS gateway policy
PUT /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>
Policy > Security > North South Security > Gateway IDS > Rules
List IDS Gateway rules
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/rules
Policy > Security > North South Security > Gateway IDS > Rules
Delete IDS Gateway rule
DELETE /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway IDS > Rules
Read IDS rule
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway IDS > Rules
Update IDS gateway rule
PATCH /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway IDS > Rules
Revise the positioning of IDS gateway rule
POST /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/rules/<rule-id>?action=revise
Policy > Security > North South Security > Gateway IDS > Rules
Create or Update IDS gateway rule
PUT /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/rules/<rule-id>
Policy > Security > North South Security > Gateway IDS > Rules > Statistics
Get IDS gateway rule statistics
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/rules/<rule-id>/statistics
Policy > Security > North South Security > Gateway IDS > Statistics
Get IDS gateway policy statistics
GET /policy/api/v1/infra/domains/<domain-id>/intrusion-service-gateway-policies/<policy-id>/statistics
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
List Firewall CPU Memory Thresholds Profile Binding Maps
GET /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps
GET /policy/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Delete Firewall CPU Memory Thresholds Profile Binding
DELETE /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/<cpu-mem-thresholds-profile-binding-map-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Get Firewall CPU Memory Thresholds Profile Binding Map
GET /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/<cpu-mem-thresholds-profile-binding-map-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Create or update Firewall CPU Memory Thresholds Profile Binding Map
PATCH /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/<cpu-mem-thresholds-profile-binding-map-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Update Firewall CPU Memory Thresholds Profile Binding Map
PUT /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profile-binding-maps/<cpu-mem-thresholds-profile-binding-map-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
List all CPU and memory thresholds profiles
GET /policy/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles
GET /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Delete CPU and memory thresholds profile
DELETE /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
DELETE /policy/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Read the CPU and memory thresholds profile
GET /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
GET /policy/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Create or update CPU and memory thresholds profile
PATCH /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
PATCH /policy/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > Cpu Memory Thresholds Profiles
Create or update CPU and memory thresholds profile
PUT /policy/api/v1/infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
PUT /policy/api/v1/global-infra/settings/firewall/cpu-mem-thresholds-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Get DNS security profile binding map
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps
Policy > Security > Security Profiles > DNS Security Profile Bindings
Delete DNS security profile binding map
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Get DNS security profile binding map
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Create or update DNS security profile binding map
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profile Bindings
Update DNS security profile binding map
PUT /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/dns-security-profile-binding-maps/<dns-security-profile-binding-map-id>
Policy > Security > Security Profiles > DNS Security Profiles
List all DNS security profiles
GET /policy/api/v1/infra/dns-security-profiles
GET /policy/api/v1/global-infra/dns-security-profiles
Policy > Security > Security Profiles > DNS Security Profiles
Delete DNS security profile
DELETE /policy/api/v1/global-infra/dns-security-profiles/<profile-id>
DELETE /policy/api/v1/infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profiles
Read the DNS Forwarder for the given tier-0 instance
GET /policy/api/v1/global-infra/dns-security-profiles/<profile-id>
GET /policy/api/v1/infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profiles
Create or update DNS security profile
PATCH /policy/api/v1/global-infra/dns-security-profiles/<profile-id>
PATCH /policy/api/v1/infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > DNS Security Profiles
Create or update DNS security profile
PUT /policy/api/v1/global-infra/dns-security-profiles/<profile-id>
PUT /policy/api/v1/infra/dns-security-profiles/<profile-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
List Firewall Flood Protection Profile Binding Maps
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Firewall Flood Protection Profile Binding
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Firewall Flood Protection Profile Binding Map
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Firewall Flood Protection Profile Binding Map
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Update Firewall Flood Protection Profile Binding Map
PUT /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-flood-protection-profile-binding-maps/<firewall-flood-protection-profile-binding-map-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
List Firewall Flood Protection Profile Binding Maps for all domains
GET /policy/api/v1/infra/domains/firewall-flood-protection-profile-binding-maps
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-0 Logical Router
DELETE /policy/api/v1/infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-0 Logical Router
GET /policy/api/v1/global-infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
GET /policy/api/v1/infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router
PATCH /policy/api/v1/infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router
PUT /policy/api/v1/infra/tier-0s/<tier0-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-0 Logical Router LocaleServices
DELETE /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
GET /policy/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
GET /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
PATCH /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-0 Logical Router LocaleServices
PUT /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-1 Logical Router
DELETE /policy/api/v1/infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-1 Logical Router
GET /policy/api/v1/global-infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
GET /policy/api/v1/infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router
PATCH /policy/api/v1/infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router
PUT /policy/api/v1/infra/tier-1s/<tier1-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Delete Flood Protection Profile Binding for Tier-1 Logical Router LocaleServices
DELETE /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Get Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
GET /policy/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
GET /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
PATCH /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profile Binding
Create or update Flood Protection Profile Binding Map for Tier-1 Logical Router LocaleServices
PUT /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/flood-protection-profile-bindings/<flood-protection-profile-binding-id>
Policy > Security > Security Profiles > Flood Protection Profiles
List Flood Protection Profiles
GET /policy/api/v1/infra/flood-protection-profiles
GET /policy/api/v1/global-infra/flood-protection-profiles
Policy > Security > Security Profiles > Flood Protection Profiles
Delete Flood Protection Profile
DELETE /policy/api/v1/infra/flood-protection-profiles/<flood-protection-profile-id>
DELETE /policy/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
Get Flood Protection Profile
GET /policy/api/v1/infra/flood-protection-profiles/<flood-protection-profile-id>
GET /policy/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
Create or update Flood Protection Profile
PATCH /policy/api/v1/infra/flood-protection-profiles/<flood-protection-profile-id>
PATCH /policy/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
Update Firewall Flood Protection Profile
PUT /policy/api/v1/infra/flood-protection-profiles/<flood-protection-profile-id>
PUT /policy/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>
Policy > Security > Security Profiles > Flood Protection Profiles
List Flood Protection Profiles
GET /policy/api/v1/infra/flood-protection-profiles/<flood-protection-profile-id>/bindings
GET /policy/api/v1/global-infra/flood-protection-profiles/<flood-protection-profile-id>/bindings
Policy > Security > Security Profiles > Monitoring Profile Binding
List Group Monitoring Profile Binding Maps
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps
Policy > Security > Security Profiles > Monitoring Profile Binding
Delete Group Monitoring Profile Binding
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Monitoring Profile Binding
Get Group Monitoring Profile Binding Map
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Monitoring Profile Binding
Create Group Monitoring Profile Binding Map
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Monitoring Profile Binding
Update Group Monitoring Profile Binding Map
PUT /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-0 Logical Router LocaleServices
DELETE /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
GET /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
GET /policy/api/v1/global-infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
PATCH /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router LocaleServices
PUT /policy/api/v1/infra/tier-0s/<tier0-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-0 Logical Router
DELETE /policy/api/v1/infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-0 Logical Router
GET /policy/api/v1/infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
GET /policy/api/v1/global-infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router
PATCH /policy/api/v1/infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-0 Logical Router
PUT /policy/api/v1/infra/tier-0s/<tier0-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-1 Logical Router LocaleServices
DELETE /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
GET /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
GET /policy/api/v1/global-infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
PATCH /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router LocaleServices
PUT /policy/api/v1/infra/tier-1s/<tier1-id>/locale-services/<locale-services-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Delete Session Timer Profile Binding for Tier-1 Logical Router
DELETE /policy/api/v1/infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Get Session Timer Profile Binding Map for Tier-1 Logical Router
GET /policy/api/v1/infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
GET /policy/api/v1/global-infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router
PATCH /policy/api/v1/infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Binding
Create or update Session Timer Profile Binding Map for Tier-1 Logical Router
PUT /policy/api/v1/infra/tier-1s/<tier1-id>/session-timer-profile-bindings/<session-timer-profile-binding-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
List Firewall Session Timer Profile Binding Maps
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps
Policy > Security > Security Profiles > Session Timer Profile Bindings
Delete Firewall Session Timer Profile Binding
DELETE /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
Get Firewall Session Timer Profile Binding Map
GET /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
GET /policy/api/v1/global-infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
Create or update Firewall Session Timer Profile Binding Map
PATCH /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
Update Firewall Session Timer Profile Binding Map
PUT /policy/api/v1/infra/domains/<domain-id>/groups/<group-id>/firewall-session-timer-profile-binding-maps/<firewall-session-timer-profile-binding-map-id>
Policy > Security > Security Profiles > Session Timer Profile Bindings
List Firewall Session Timer Profile Binding Maps for all domains
GET /policy/api/v1/global-infra/domains/firewall-session-timer-profile-binding-maps
GET /policy/api/v1/infra/domains/firewall-session-timer-profile-binding-maps
Policy > Security > Security Profiles > Session Timer Profiles
List Firewall Session Timer Profiles
GET /policy/api/v1/global-infra/firewall-session-timer-profiles
GET /policy/api/v1/infra/firewall-session-timer-profiles
Policy > Security > Security Profiles > Session Timer Profiles
Delete Firewall Session Timer Profile
DELETE /policy/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
DELETE /policy/api/v1/infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
Get Firewall Session Timer Profile
GET /policy/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
GET /policy/api/v1/infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
Create or update Firewall Session Timer Profile
PATCH /policy/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
PATCH /policy/api/v1/infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
Update Firewall Session Timer Profile
PUT /policy/api/v1/global-infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
PUT /policy/api/v1/infra/firewall-session-timer-profiles/<firewall-session-timer-profile-id>
Policy > Security > Security Profiles > Session Timer Profiles
List Session Timer Profiles
GET /policy/api/v1/infra/session-timer-profiles/<session-timer-profile-id>/bindings
GET /policy/api/v1/global-infra/session-timer-profiles/<session-timer-profile-id>/bindings
Policy > Security > Service Insertion > Partner Services
Read partner services
GET /policy/api/v1/infra/partner-services
Policy > Security > Service Insertion > Partner Services
Read partner service identified by provided name
GET /policy/api/v1/infra/partner-services/<service-name>
Policy > Security > Service Insertion > Redirection Policies
List redirection policies for a domain
GET /policy/api/v1/infra/domains/<domain-id>/redirection-policies
Policy > Security > Service Insertion > Redirection Policies
Delete redirection policy
DELETE /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>
Policy > Security > Service Insertion > Redirection Policies
Read redirection policy
GET /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>
Policy > Security > Service Insertion > Redirection Policies
Create or update redirection policy
PATCH /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>
Policy > Security > Service Insertion > Redirection Policies
Create or update redirection policy
PUT /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>
Policy > Security > Service Insertion > Redirection Policies
List rules
GET /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>/rules
Policy > Security > Service Insertion > Redirection Policies
Delete RedirectionRule
DELETE /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>/rules/<rule-id>
Policy > Security > Service Insertion > Redirection Policies
Read rule
GET /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>/rules/<rule-id>
Policy > Security > Service Insertion > Redirection Policies
Update redirection rule
PATCH /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>/rules/<rule-id>
Policy > Security > Service Insertion > Redirection Policies
Update redirection rule
PUT /policy/api/v1/infra/domains/<domain-id>/redirection-policies/<redirection-policy-id>/rules/<rule-id>
Policy > Security > Service Insertion > Redirection Policies
List redirection policies
GET /policy/api/v1/infra/domains/redirection-policies
Policy > Security > Service Insertion > Service Chains
List service chains
GET /policy/api/v1/infra/service-chains
Policy > Security > Service Insertion > Service Chains
Delete Service chain
DELETE /policy/api/v1/infra/service-chains/<service-chain-id>
Policy > Security > Service Insertion > Service Chains
Read service chain
GET /policy/api/v1/infra/service-chains/<service-chain-id>
Policy > Security > Service Insertion > Service Chains
Create service chain
PATCH /policy/api/v1/infra/service-chains/<service-chain-id>
Policy > Security > Service Insertion > Service Chains
Create or update service chain
PUT /policy/api/v1/infra/service-chains/<service-chain-id>
Policy > Security > Service Insertion > Service Chains
Read service paths for a given service chain
GET /policy/api/v1/infra/service-chains/<service-chain-id>/service-paths
Policy > Security > Service Insertion > Service Chains
List all service chain mappings for given service profile.
GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>/service-chain-mappings
Policy > Security > Service Insertion > Service Definitions
List all Service Definitions registered on given enforcement point.
GET /policy/api/v1/enforcement-points/<enforcement-point-id>/service-definitions
Policy > Security > Service Insertion > Service Definitions
Create a Service Definition on given enforcement point.
POST /policy/api/v1/enforcement-points/<enforcement-point-id>/service-definitions
Policy > Security > Service Insertion > Service Definitions
Delete an existing Service Definition on the given enforcement point
DELETE /policy/api/v1/enforcement-points/<enforcement-point-id>/service-definitions/<service-definition-id>
Policy > Security > Service Insertion > Service Definitions
Read Service Definition with given service-definition-id.
GET /policy/api/v1/enforcement-points/<enforcement-point-id>/service-definitions/<service-definition-id>
Policy > Security > Service Insertion > Service Definitions
Update an existing Service Definition on the given enforcement point
PUT /policy/api/v1/enforcement-points/<enforcement-point-id>/service-definitions/<service-definition-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Read all BYOD service instance objects under a tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Delete BYOD policy service instance
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Read BYOD service instance
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Create BYOD service instance
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Create BYOD service instance
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
List all service instance endpoint
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Delete service instance endpoint
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Read service instance endpoint
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Create service instance endpoint
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Create service instance endpoint
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Read all service instance objects under a tier-0
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Delete policy service instance
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Read service instance
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Create service instance
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-0 Gateways
Create service instance
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Read all Tier1 BYOD service instance objects under a tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Delete BYOD policy service instance
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Read Tier1 BYOD service instance
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Create Tier1 BYOD service instance
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Create Tier1 BYOD service instance
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
List all Tier1 service instance endpoint
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Delete Tier1 service instance endpoint
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Read Tier1 service instance endpoint
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Create Tier1 service instance endpoint
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Create Tier1 service instance endpoint
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Read all service instance objects under a tier-1
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Delete Tier1 policy service instance
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Read Tier1 service instance
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Create Tier1 service instance
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service Instances > Tier-1 Gateways
Create Tier1 service instance
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
Policy > Security > Service Insertion > Service References
List service references
GET /policy/api/v1/infra/service-references
Policy > Security > Service Insertion > Service References
Delete Service Reference
DELETE /policy/api/v1/infra/service-references/<service-reference-id>
Policy > Security > Service Insertion > Service References
Read service reference
GET /policy/api/v1/infra/service-references/<service-reference-id>
Policy > Security > Service Insertion > Service References
Create service reference
PATCH /policy/api/v1/infra/service-references/<service-reference-id>
Policy > Security > Service Insertion > Service References
Create service reference
PUT /policy/api/v1/infra/service-references/<service-reference-id>
Policy > Security > Service Insertion > Service References
List service profiles
GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles
Policy > Security > Service Insertion > Service References
Delete Service profile
DELETE /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>
Policy > Security > Service Insertion > Service References
Read service profile
GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>
Policy > Security > Service Insertion > Service References
Create service profile
PATCH /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>
Policy > Security > Service Insertion > Service References
Create or update service profile
PUT /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>
Policy > Security > Service Insertion > Service References
Get Groups used in Redirection rules for a given Service Profile.
GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>/group-associations
Policy > Security > Service Insertion > Settings > Configuration Status
Get service insertion configuration status
GET /policy/api/v1/infra/settings/service-insertion/security/status
Policy > Security > Service Insertion > Settings > Configuration Status
Update service insertion status configuration
PATCH /policy/api/v1/infra/settings/service-insertion/security/status
Policy > Security > Service Insertion > Settings > Configuration Status
Update service insertion status configuration
PUT /policy/api/v1/infra/settings/service-insertion/security/status
Policy > Security > Service Insertion > Settings > Exclusion List
Additional API to read service insertion exclude list without filtering out the system owned members
GET /policy/api/v1/infra/settings/service-insertion/security/exclude-list?system_owned=true
Policy > Security > Service Insertion > Settings > Exclusion List
Default API to read service insertion exclude list with system owned members filtered out
GET /policy/api/v1/infra/settings/service-insertion/security/exclude-list
Policy > Security > Service Insertion > Settings > Exclusion List
Patch service insertion exclusion list for security policy
PATCH /policy/api/v1/infra/settings/service-insertion/security/exclude-list
Policy > Security > Service Insertion > Settings > Exclusion List
Update service insertion exclusion list
PUT /policy/api/v1/infra/settings/service-insertion/security/exclude-list
Policy > Security > Service Insertion > Statistics
Get statistics for all runtimes associated with this PolicyServiceInstance
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>/statistics
Policy > Security > Service Insertion > Statistics
Get statistics for all runtimes associated with this Tier1 PolicyServiceInstance
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>/statistics
Policy > Security > Service Insertion > Virtual Endpoints > Tier-0 Gateways
List all virtual endpoints
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints
Policy > Security > Service Insertion > Virtual Endpoints > Tier-0 Gateways
Delete virtual endpoint
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Policy > Security > Service Insertion > Virtual Endpoints > Tier-0 Gateways
Read virtual endpoint
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Policy > Security > Service Insertion > Virtual Endpoints > Tier-0 Gateways
Create or update virtual endpoint
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Policy > Security > Service Insertion > Virtual Endpoints > Tier-0 Gateways
Create or update virtual endpoint
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Policy > Security > Service Insertion > Virtual Endpoints > Tier-1 Gateways
List all virtual endpoints
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints
Policy > Security > Service Insertion > Virtual Endpoints > Tier-1 Gateways
Delete virtual endpoint
DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Policy > Security > Service Insertion > Virtual Endpoints > Tier-1 Gateways
Read virtual endpoint
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Policy > Security > Service Insertion > Virtual Endpoints > Tier-1 Gateways
Create or update virtual endpoint
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Policy > Security > Service Insertion > Virtual Endpoints > Tier-1 Gateways
Create or update virtual endpoint
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/endpoints/virtual-endpoints/<virtual-endpoint-id>
Search > Search API
DSL (Domain Specific Language) search API
GET /policy/api/v1/search/dsl (Experimental)
GET /api/v1/search/dsl (Experimental)
Search > Search API
Full text search API
GET /policy/api/v1/search/query
GET /api/v1/search/query
System Administration > Configuration > Directory Service > Domains
Scan the size of a directory domain
POST /api/v1/directory/domain-size (Deprecated)
System Administration > Configuration > Directory Service > Domains
List all configured domains
GET /api/v1/directory/domains (Deprecated)
System Administration > Configuration > Directory Service > Domains
Create a directory domain
POST /api/v1/directory/domains (Deprecated)
System Administration > Configuration > Directory Service > Domains
Delete a specific domain with given identifier
DELETE /api/v1/directory/domains/<domain-id> (Deprecated)
System Administration > Configuration > Directory Service > Domains
Get a specific domain with given identifier
GET /api/v1/directory/domains/<domain-id> (Deprecated)
System Administration > Configuration > Directory Service > Domains
Invoke full sync or delta sync for a specific domain, with additional delay in seconds if needed. Stop sync will try to stop any pending sync if any to return to idle state.
POST /api/v1/directory/domains/<domain-id> (Deprecated)
System Administration > Configuration > Directory Service > Domains
Update a directory domain
PUT /api/v1/directory/domains/<domain-id> (Deprecated)
System Administration > Configuration > Directory Service > Domains
Fetch all organization units for a Directory domain.
POST /api/v1/directory/domains/<domain-id>/org-units (Deprecated)
System Administration > Configuration > Directory Service > Domains
Get domain sync statistics for the given identifier
GET /api/v1/directory/domains/<domain-id>/sync-stats (Deprecated)
System Administration > Configuration > Directory Service > Domains
Fetch all organization units for a LDAP server.
POST /api/v1/directory/org-units (Deprecated)
System Administration > Configuration > Directory Service > Event-Log-Server
Create a Event Log server for Firewall Identity store
PATCH /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/event-log-servers/<event-log-server-id>
System Administration > Configuration > Directory Service > Groups
Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)
GET /api/v1/directory/domains/<domain-id>/groups (Deprecated)
System Administration > Configuration > Directory Service > Groups
List members of a directory group
GET /api/v1/directory/domains/<domain-id>/groups/<group-id>/member-groups (Deprecated)
System Administration > Configuration > Directory Service > LDAP Servers
List all configured domain LDAP servers
GET /api/v1/directory/domains/<domain-id>/ldap-servers (Deprecated)
System Administration > Configuration > Directory Service > LDAP Servers
Create a LDAP server for directory domain
POST /api/v1/directory/domains/<domain-id>/ldap-servers (Deprecated)
System Administration > Configuration > Directory Service > LDAP Servers
Delete a LDAP server for directory domain
DELETE /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id> (Deprecated)
System Administration > Configuration > Directory Service > LDAP Servers
Get a specific LDAP server for a given directory domain
GET /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id> (Deprecated)
System Administration > Configuration > Directory Service > LDAP Servers
Test a LDAP server connection for directory domain
POST /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id> (Deprecated)
System Administration > Configuration > Directory Service > LDAP Servers
Update a LDAP server for directory domain
PUT /api/v1/directory/domains/<domain-id>/ldap-servers/<server-id> (Deprecated)
System Administration > Configuration > Directory Service > LDAP Servers
Test a directory domain LDAP server connectivity
POST /api/v1/directory/ldap-server (Deprecated)
System Administration > Configuration > Fabric > Cloud Native Service Instances
Returns the List of cloud native service instances
GET /api/v1/fabric/cloud-native-service-instances
System Administration > Configuration > Fabric > Cloud Native Service Instances
Returns information about a particular cloud native service instance by external-id.
GET /api/v1/fabric/cloud-native-service-instances/<external-id>
System Administration > Configuration > Fabric > Compute Collections
Return the List of Compute Collections
GET /api/v1/fabric/compute-collections
System Administration > Configuration > Fabric > Compute Collections
Return Compute Collection Information
GET /api/v1/fabric/compute-collections/<cc-ext-id>
System Administration > Configuration > Fabric > Compute Collections
Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.
POST /api/v1/fabric/compute-collections/<cc-ext-id>
System Administration > Configuration > Fabric > Compute Collections
Get status of member host nodes of the compute-collection. Only nsx prepared host nodes in the specified compute-collection are included in the response. cc-ext-id should be of type VC_Cluster.
GET /api/v1/fabric/compute-collections/<cc-ext-id>/member-status
System Administration > Configuration > Fabric > Compute Collections
List the Physical Network Interface for all discovered nodes
GET /api/v1/fabric/compute-collections/<cc-ext-id>/network/physical-interfaces
System Administration > Configuration > Fabric > Compute Managers
Return inventory configuration
GET /api/v1/configs/inventory
System Administration > Configuration > Fabric > Compute Managers
Return the List of Compute managers
GET /api/v1/fabric/compute-managers
System Administration > Configuration > Fabric > Compute Managers
Register compute manager with NSX
POST /api/v1/fabric/compute-managers
System Administration > Configuration > Fabric > Compute Managers
Unregister a compute manager
DELETE /api/v1/fabric/compute-managers/<compute-manager-id>
System Administration > Configuration > Fabric > Compute Managers
Return compute manager Information
GET /api/v1/fabric/compute-managers/<compute-manager-id>
System Administration > Configuration > Fabric > Compute Managers
Update compute manager
PUT /api/v1/fabric/compute-managers/<compute-manager-id>
System Administration > Configuration > Fabric > Compute Managers
Get the realized state of a compute manager
GET /api/v1/fabric/compute-managers/<compute-manager-id>/state
System Administration > Configuration > Fabric > Compute Managers
Return runtime status information for a compute manager
GET /api/v1/fabric/compute-managers/<compute-manager-id>/status
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
List Edge Clusters
GET /api/v1/edge-clusters
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Create Edge Cluster
POST /api/v1/edge-clusters
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Delete Edge Cluster
DELETE /api/v1/edge-clusters/<edge-cluster-id>
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Read Edge Cluster
GET /api/v1/edge-clusters/<edge-cluster-id>
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Replace the transport node in the specified member of the edge-cluster
POST /api/v1/edge-clusters/<edge-cluster-id>?action=replace_transport_node
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Update Edge Cluster
PUT /api/v1/edge-clusters/<edge-cluster-id>
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Get the Allocation details of an edge cluster
GET /api/v1/edge-clusters/<edge-cluster-id>/allocation-status
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Get the Realized State of a Edge Cluster
GET /api/v1/edge-clusters/<edge-cluster-id>/state
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters
Get the status for the Edge cluster of the given id
GET /api/v1/edge-clusters/<edge-cluster-id>/status
System Administration > Configuration > Fabric > Edge Clusters > Failure Domains
List Failure Domains
GET /api/v1/failure-domains
System Administration > Configuration > Fabric > Edge Clusters > Failure Domains
Create Failure Domain
POST /api/v1/failure-domains
System Administration > Configuration > Fabric > Edge Clusters > Failure Domains
Delete Failure Domain
DELETE /api/v1/failure-domains/<failure-domain-id>
System Administration > Configuration > Fabric > Edge Clusters > Failure Domains
Get a Failure Domain
GET /api/v1/failure-domains/<failure-domain-id>
System Administration > Configuration > Fabric > Edge Clusters > Failure Domains
Update Failure Domain
PUT /api/v1/failure-domains/<failure-domain-id>
System Administration > Configuration > Fabric > Nodes > Certificates
Read node certificate properties
GET /api/v1/transport-nodes/<transport-node-id>/node/certificate
System Administration > Configuration > Fabric > Nodes > Cluster Control Planes
List Cluster Control Plane
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes
System Administration > Configuration > Fabric > Nodes > Cluster Control Planes
Delete a Cluster Control Plane Node
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>
System Administration > Configuration > Fabric > Nodes > Cluster Control Planes
Get a Cluster Control Plane
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>
System Administration > Configuration > Fabric > Nodes > Cluster Control Planes
Create or Update Cluster Control Plane to NSX-T
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>
System Administration > Configuration > Fabric > Nodes > DNS
Read the Node's Name Servers
GET /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers
GET /api/v1/cluster/<cluster-node-id>/node/network/name-servers
GET /api/v1/node/network/name-servers
System Administration > Configuration > Fabric > Nodes > DNS
Update the Node's Name Servers
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers
PUT /api/v1/cluster/<cluster-node-id>/node/network/name-servers
PUT /api/v1/node/network/name-servers
System Administration > Configuration > Fabric > Nodes > DNS
Read the Node's Search Domains
GET /api/v1/cluster/<cluster-node-id>/node/network/search-domains
GET /api/v1/node/network/search-domains
GET /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains
System Administration > Configuration > Fabric > Nodes > DNS
Update the Node's Search Domains
PUT /api/v1/cluster/<cluster-node-id>/node/network/search-domains
PUT /api/v1/node/network/search-domains
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains
System Administration > Configuration > Fabric > Nodes > Discovered Nodes
Return the List of Discovered Nodes
GET /api/v1/fabric/discovered-nodes
System Administration > Configuration > Fabric > Nodes > Discovered Nodes
Return Discovered Node Information
GET /api/v1/fabric/discovered-nodes/<node-ext-id>
System Administration > Configuration > Fabric > Nodes > Discovered Nodes
Apply cluster level config on Discovered Node
POST /api/v1/fabric/discovered-nodes/<node-ext-id>?action=reapply_cluster_config
System Administration > Configuration > Fabric > Nodes > Discovered Nodes
Created Transport Node for Discovered Node
POST /api/v1/fabric/discovered-nodes/<node-ext-id>?action=create_transport_node
System Administration > Configuration > Fabric > Nodes > Fabric Nodes
Return list of supported host OS types
GET /api/v1/fabric/ostypes
System Administration > Configuration > Fabric > Nodes > File Store
List node files
GET /api/v1/node/file-store
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store
GET /api/v1/cluster/<cluster-node-id>/node/file-store
System Administration > Configuration > Fabric > Nodes > File Store
Create directory in remote file server
POST /api/v1/node/file-store?action=create_remote_directory
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store?action=create_remote_directory
POST /api/v1/cluster/<cluster-node-id>/node/file-store?action=create_remote_directory
System Administration > Configuration > Fabric > Nodes > File Store
Delete file
DELETE /api/v1/node/file-store/<file-name>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
DELETE /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
System Administration > Configuration > Fabric > Nodes > File Store
Read file properties
GET /api/v1/node/file-store/<file-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
System Administration > Configuration > Fabric > Nodes > File Store
Copy a remote file to the file store
POST /api/v1/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
System Administration > Configuration > Fabric > Nodes > File Store
Upload a file to the file store
POST /api/v1/node/file-store/<file-name>
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>
System Administration > Configuration > Fabric > Nodes > File Store
Copy file in the file store to a remote file store
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/node/file-store/<file-name>?action=copy_to_remote_file
System Administration > Configuration > Fabric > Nodes > File Store
Read file contents
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
GET /api/v1/node/file-store/<file-name>/data
System Administration > Configuration > Fabric > Nodes > File Store
Replace file contents
PUT /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data
PUT /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
PUT /api/v1/node/file-store/<file-name>/data
System Administration > Configuration > Fabric > Nodes > File Store
Read file thumbprint
GET /api/v1/node/file-store/<file-name>/thumbprint
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/thumbprint
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/thumbprint
System Administration > Configuration > Fabric > Nodes > Hardening > Mandatory Access Control
Gets the enable status for Mandatory Access Control
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
GET /api/v1/node/hardening-policy/mandatory-access-control
System Administration > Configuration > Fabric > Nodes > Hardening > Mandatory Access Control
Enable or disable Mandatory Access Control
PUT /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control
PUT /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
PUT /api/v1/node/hardening-policy/mandatory-access-control
System Administration > Configuration > Fabric > Nodes > Hardening > Mandatory Access Control
Get the report for Mandatory Access Control
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control/report
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control/report
GET /api/v1/node/hardening-policy/mandatory-access-control/report
System Administration > Configuration > Fabric > Nodes > LLDP
List LLDP Neighbor Properties of Fabric Node
GET /api/v1/lldp/fabric-nodes/<fabric-node-id>/interfaces
System Administration > Configuration > Fabric > Nodes > LLDP
Read LLDP Neighbor Properties of Fabric Node by Interface Name
GET /api/v1/lldp/fabric-nodes/<fabric-node-id>/interfaces/<interface-name>
System Administration > Configuration > Fabric > Nodes > LLDP
List LLDP Neighbor Properties of Transport Node
GET /api/v1/lldp/transport-nodes/<node-id>/interfaces
System Administration > Configuration > Fabric > Nodes > LLDP
Read LLDP Neighbor Properties of Transport Node by Interface Name
GET /api/v1/lldp/transport-nodes/<node-id>/interfaces/<interface-name>
System Administration > Configuration > Fabric > Nodes > Logs
List available node logs
GET /api/v1/transport-nodes/<transport-node-id>/node/logs
GET /api/v1/cluster/<cluster-node-id>/node/logs
GET /api/v1/node/logs
System Administration > Configuration > Fabric > Nodes > Logs
Read node log properties
GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name>
GET /api/v1/node/logs/<log-name>
GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>
System Administration > Configuration > Fabric > Nodes > Logs
Read node log contents
GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name>/data
GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>/data
GET /api/v1/node/logs/<log-name>/data
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge stateful flows
GET /api/v1/transport-nodes/<transport-node-id>/node/flows
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge stateful flows by interface
GET /api/v1/transport-nodes/<transport-node-id>/node/flows/interfaces/<iface-uuid>
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge stateful flows by router
GET /api/v1/transport-nodes/<transport-node-id>/node/flows/logical-routers/<uuid>
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Read NSX EdgeDatapath service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Restart, start or stop the NSX EdgeDatapath service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge Datapath service properties
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge dataplane cpu stats
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/cpu-stats
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge dataplane control packets prioritization setting
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/ctrl-prio
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Check dynamic core feature enabled status of NSX Edge dataplane
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/dynamic-core
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge dataplane dynamic core feature enabled status
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/dynamic-core
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge dataplane flow cache setting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-cache
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge dataplane flow cache setting
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-cache
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Return top 10 flows information
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Start NSX Edge dataplane flow monitor
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge dataplane firewall connections
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/fw-conns
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge dataplane firewall stats
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/fw-stats
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge dataplane interrupt mode setting
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/intr-mode
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge dataplane l2vpn pmtu message generation setting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l2vpn-pmtu
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge dataplane l2vpn pmtu message generation setting
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l2vpn-pmtu
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Depreciated. Please use /node/services/dataplane/pmtu-learning
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l3vpn-pmtu (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Depreciated. Please use /node/services/dataplane/pmtu-learning
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l3vpn-pmtu (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge dataplane pmtu learning setting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/pmtu-learning
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge dataplane pmtu learning setting
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/pmtu-learning
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Update NSX Edge dataplane QAT feature enabled status
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/qat-enable
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge dataplane QAT setting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/qat-status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Get NSX Edge rx and tx queue number per port per core
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/queue-num-per-port-per-core
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Set NSX Edge rx and tx queue number per port per core
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/queue-num-per-port-per-core
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Return rx/tx ring size information
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/ring-size
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Set NSX Edge rx ring size for physical ports
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/rx-ring-size
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Read NSX EdgeDatapath service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane
Set NSX Edge tx ring size for physical ports
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/tx-ring-size
System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis
Read edge config diagnosis
GET /api/v1/transport-nodes/<transport-node-id>/node/diagnosis
System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis
Read edge diagnosis inconsistency
GET /api/v1/transport-nodes/<transport-node-id>/node/diagnosis/inconsistency
System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis
Logical-router diagnosis
GET /api/v1/transport-nodes/<transport-node-id>/node/logical-routers/<logical-router-id>/diagnosis
System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis
Logical-routers diagnosis
GET /api/v1/transport-nodes/<transport-node-id>/node/logical-routers/diagnosis
System Administration > Configuration > Fabric > Nodes > NSX Edge > Manager Configuration
Current configuration for this node
GET /api/v1/transport-nodes/<transport-node-id>/node/configuration
System Administration > Configuration > Fabric > Nodes > NSX Edge > Nestdb
Read NSX Nestdb service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb
System Administration > Configuration > Fabric > Nodes > NSX Edge > Nestdb
Restart, start or stop the NSX Nestdb service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Edge > Nestdb
Read NSX Nestdb service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > DHCP
Read NSX Edge DHCP service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > DHCP
Read NSX Edge DHCP service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > DHCP Service
Update NSX Edge DHCP service properties
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Docker
Read NSX Edge Docker service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/docker
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Docker
Read NSX Edge Docker service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/docker/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Ipsecvpn Service
Update NSX Edge Ipsec VPN service properties
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Local-Controller
Read NSX Edge NSXA service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Local-Controller
Restart, start or stop the NSX EdgeNSXA service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Local-Controller
Read NSX EdgeNSXA service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Maintenance Mode
Get Edge maintenance mode
GET /api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Maintenance Mode
Set Edge maintenance mode
PUT /api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > NSX Ops Agent Service
Read NSX OpsAgent service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > NSX Ops Agent Service
Restart, start or stop the NSX OpsAgent service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > NSX Ops Agent Service
Read NSX OpsAgent service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing
Read NSX EdgeMSR service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing
Read NSX EdgeMSRConfig service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router-config
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing
Read NSX EdgeMSRConfig service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router-config/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing
Read NSX EdgeMSR service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Security-Hub
Read NSX security-hub service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/security-hub
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Security-Hub
Read NSX Edge security-hub service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/security-hub/status
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > VPN
Read NSX Edge Ipsec VPN service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn
System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > VPN
Read NSX Edge Ipsec VPN service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Management Plane
Delete management plane configuration for this node
DELETE /api/v1/node/management-plane
DELETE /api/v1/cluster/<cluster-node-id>/node/management-plane
System Administration > Configuration > Fabric > Nodes > NSX Manager > Management Plane
Get management plane configuration for this node
GET /api/v1/node/management-plane (Experimental)
GET /api/v1/cluster/<cluster-node-id>/node/management-plane (Experimental)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Management Plane
Update management plane configuration for this node
PUT /api/v1/node/management-plane (Experimental)
PUT /api/v1/cluster/<cluster-node-id>/node/management-plane (Experimental)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Manager Configuration
NodeMode
GET /api/v1/node/mode
GET /api/v1/cluster/<cluster-node-id>/node/mode
System Administration > Configuration > Fabric > Nodes > NSX Manager > Manager Network Interfaces
Read the NSX Manager/Controller's Network Interface Statistics
GET /api/v1/cluster/nodes/<node-id>/network/interfaces/<interface-id>/stats
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Async Replicator Service
Read the Async Replicator service properties
GET /api/v1/node/services/async_replicator
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Async Replicator Service
Restart, start or stop the Async Replicator service
POST /api/v1/node/services/async_replicator?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/async_replicator?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Async Replicator Service
Read the Async Replicator service status
GET /api/v1/node/services/async_replicator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Cluster Manager Service
Read cluster boot manager service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager
GET /api/v1/node/services/cluster_manager
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Cluster Manager Service
Restart, start or stop the cluster boot manager service
POST /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager?action=start|stop|restart
POST /api/v1/node/services/cluster_manager?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Cluster Manager Service
Read cluster boot manager service status
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager/status
GET /api/v1/node/services/cluster_manager/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Cm Inventory Service
Read cm inventory service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory
GET /api/v1/node/services/cm-inventory
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Cm Inventory Service
Restart, start or stop the manager service
POST /api/v1/node/services/cm-inventory?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Cm Inventory Service
Read manager service status
GET /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory/status
GET /api/v1/node/services/cm-inventory/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Controller Service
Read controller service properties
GET /api/v1/node/services/controller
GET /api/v1/cluster/<cluster-node-id>/node/services/controller
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Controller Service
Restart, start or stop the controller service
POST /api/v1/cluster/<cluster-node-id>/node/services/controller?action=restart|start|stop
POST /api/v1/node/services/controller?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Controller Service
Read controller server certificate properties
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/controller-certificate
GET /api/v1/node/services/controller/controller-certificate
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Controller Service
Get the status (Enabled/Disabled) of controller profiler
GET /api/v1/node/services/controller/profiler
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/profiler
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Controller Service
Enable or disable controller profiler
PUT /api/v1/node/services/controller/profiler
PUT /api/v1/cluster/<cluster-node-id>/node/services/controller/profiler
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Controller Service
Read controller service status
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/status
GET /api/v1/node/services/controller/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Dispatcher Service
Read NSX Edge Dispatcher service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Dispatcher Service
Restart, start or stop the NSX Edge Dispatcher service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Dispatcher Service
Read NSX Edge Dispatcher service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Read http service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/http (Deprecated)
GET /api/v1/node/services/http (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Update http service certificate
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=apply_certificate
POST /api/v1/node/services/http?action=apply_certificate
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Stop the http service
POST /api/v1/node/services/http?action=stop
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Start the http service
POST /api/v1/node/services/http?action=start
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=start
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Restart the http service
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=restart
POST /api/v1/node/services/http?action=restart
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Update http service properties
PUT /api/v1/cluster/<cluster-node-id>/node/services/http (Deprecated)
PUT /api/v1/node/services/http (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Read http service status
GET /api/v1/node/services/http/status
GET /api/v1/cluster/<cluster-node-id>/node/services/http/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Idps Reporting Service
Read the idps-reporting service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting
GET /api/v1/node/services/idps-reporting
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Idps Reporting Service
Restart, start or stop the idps-reporting service
POST /api/v1/node/services/idps-reporting?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Idps Reporting Service
Read the idps-reporting service status
GET /api/v1/node/services/idps-reporting/status
GET /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Install Upgrade Service
Read NSX install-upgrade service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade
GET /api/v1/node/services/install-upgrade
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Install Upgrade Service
Restart, start or stop the NSX install-upgrade service
POST /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade?action=restart|start|stop
POST /api/v1/node/services/install-upgrade?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Install Upgrade Service
Update NSX install-upgrade service properties
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade
PUT /api/v1/node/services/install-upgrade
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Install Upgrade Service
Read NSX install-upgrade service status
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/status
GET /api/v1/node/services/install-upgrade/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Install Upgrade Service
Update UC state properties
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/uc-state
PUT /api/v1/node/services/install-upgrade/uc-state
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Local-Controller Service
Update NSX Edge NSXA service properties
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Manager Service
Read service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/manager
GET /api/v1/node/services/manager
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Manager Service
Reset the logging levels to default values
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/node/services/manager?action=reset-manager-logging-levels
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Manager Service
Restart, start or stop the service
POST /api/v1/node/services/manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Manager Service
Update service properties
PUT /api/v1/cluster/<cluster-node-id>/node/services/manager
PUT /api/v1/node/services/manager
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Manager Service
Read service status
GET /api/v1/node/services/manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/manager/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Messaging Manager Service
Read NSX Messaging Manager service properties
GET /api/v1/node/services/messaging-manager
GET /api/v1/cluster/<cluster-node-id>/node/services/messaging-manager
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Messaging Manager Service
Restart, start or stop the NSX Messaging Manager service
POST /api/v1/cluster/<cluster-node-id>/node/services/messaging-manager?action=restart|start|stop
POST /api/v1/node/services/messaging-manager?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Messaging Manager Service
Read NSX Messaging Manager service status
GET /api/v1/cluster/<cluster-node-id>/node/services/messaging-manager/status
GET /api/v1/node/services/messaging-manager/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Metadata Proxy Service
Read Metadata-proxy service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Metadata Proxy Service
Read Metadata-proxy service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Migration Coordinator Service
Read migration coordinator service properties
GET /api/v1/node/services/migration-coordinator
GET /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Migration Coordinator Service
Restart, start or stop the migration coordinator service
POST /api/v1/node/services/migration-coordinator?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Migration Coordinator Service
Read migration coordinator service status
GET /api/v1/node/services/migration-coordinator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > NSX Control Plane Agent Service
Read NSX Control Plane Agent service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > NSX Control Plane Agent Service
Restart, start or stop the NSX Control Plane Agent service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > NSX Control Plane Agent Service
Read NSX Control Plane Agent service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Node Stats Service
Read NSX node-stats service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/node-stats
GET /api/v1/node/services/node-stats
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Node Stats Service
Restart, start or stop the NSX node-stats service
POST /api/v1/cluster/<cluster-node-id>/node/services/node-stats?action=restart|start|stop
POST /api/v1/node/services/node-stats?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Node Stats Service
Read NSX node-stats service status
GET /api/v1/node/services/node-stats/status
GET /api/v1/cluster/<cluster-node-id>/node/services/node-stats/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Policy Service
Read service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/policy
GET /api/v1/node/services/policy
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Policy Service
Restart, start or stop the service
POST /api/v1/node/services/policy?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/policy?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Policy Service
Reset the logging levels to default values
POST /api/v1/cluster/<cluster-node-id>/node/services/policy?action=reset-manager-logging-levels
POST /api/v1/node/services/policy?action=reset-manager-logging-levels
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Policy Service
Update service properties
PUT /api/v1/cluster/<cluster-node-id>/node/services/policy
PUT /api/v1/node/services/policy
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Policy Service
Read service status
GET /api/v1/node/services/policy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/policy/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Search Service
Read NSX Search service properties
GET /api/v1/node/services/search
GET /api/v1/cluster/<cluster-node-id>/node/services/search
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Search Service
Restart, start or stop the NSX Search service
POST /api/v1/cluster/<cluster-node-id>/node/services/search?action=restart|start|stop
POST /api/v1/node/services/search?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Search Service
Read NSX Search service status
GET /api/v1/node/services/search/status
GET /api/v1/cluster/<cluster-node-id>/node/services/search/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Read Telemetry service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry
GET /api/v1/node/services/telemetry
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Restart, start or stop Telemetry service
POST /api/v1/node/services/telemetry?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/telemetry?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Read Telemetry service status
GET /api/v1/node/services/telemetry/status
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry/status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > User Interface Service
Read ui service properties
GET /api/v1/node/services/ui-service
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > User Interface Service
Restart, Start and Stop the ui service
POST /api/v1/cluster/<cluster-node-id>/node/services/ui-service?action=restart|start|stop
POST /api/v1/node/services/ui-service?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > User Interface Service
Read ui service status
GET /api/v1/node/services/ui-service/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service/status
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Read network configuration properties
GET /api/v1/cluster/<cluster-node-id>/node/network
GET /api/v1/transport-nodes/<transport-node-id>/node/network
GET /api/v1/node/network
System Administration > Configuration > Fabric > Nodes > Network Interfaces
List the Node's Network Interfaces
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces
GET /api/v1/node/network/interfaces
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Read the Node's Network Interface
GET /api/v1/node/network/interfaces/<interface-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Update the Node's Network Interface
PUT /api/v1/node/network/interfaces/<interface-id>
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>
PUT /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
System Administration > Configuration > Fabric > Nodes > Network Interfaces
Read the Node's Network Interface Statistics
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>/stats
GET /api/v1/node/network/interfaces/<interface-id>/stats
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>/stats
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
List node network routes
GET /api/v1/cluster/<cluster-node-id>/node/network/routes
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes
GET /api/v1/node/network/routes
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
Create node network route
POST /api/v1/cluster/<cluster-node-id>/node/network/routes
POST /api/v1/transport-nodes/<transport-node-id>/node/network/routes
POST /api/v1/node/network/routes
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
Delete node network route
DELETE /api/v1/node/network/routes/<route-id>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id>
DELETE /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing
Read node network route
GET /api/v1/node/network/routes/<route-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id>
GET /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
System Administration > Configuration > Fabric > Nodes > Physical Servers
Return the list of physical servers
GET /api/v1/fabric/physical-servers
System Administration > Configuration > Fabric > Nodes > Physical Servers
Return a specific physical server
GET /api/v1/fabric/physical-servers/<physical-server-id>
System Administration > Configuration > Fabric > Nodes > Services
List node services
GET /api/v1/node/services
GET /api/v1/transport-nodes/<transport-node-id>/node/services
GET /api/v1/cluster/<cluster-node-id>/node/services
System Administration > Configuration > Fabric > Nodes > Services > Log Insight
Read liagent service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent
GET /api/v1/node/services/liagent
GET /api/v1/cluster/<cluster-node-id>/node/services/liagent
System Administration > Configuration > Fabric > Nodes > Services > Log Insight
Restart, start or stop the liagent service
POST /api/v1/cluster/<cluster-node-id>/node/services/liagent?action=restart|start|stop
POST /api/v1/node/services/liagent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/liagent?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > Log Insight
Read liagent service status
GET /api/v1/cluster/<cluster-node-id>/node/services/liagent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent/status
GET /api/v1/node/services/liagent/status
System Administration > Configuration > Fabric > Nodes > Services > NSX Message Service
Read NSX Message Bus service properties
GET /api/v1/node/services/nsx-message-bus
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus
System Administration > Configuration > Fabric > Nodes > Services > NSX Message Service
Restart, start or stop the NSX Message Bus service
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus?action=restart|start|stop
POST /api/v1/node/services/nsx-message-bus?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > NSX Message Service
Read NSX Message Bus service status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus/status
GET /api/v1/node/services/nsx-message-bus/status
System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client
Read NSX Platform Client service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client
GET /api/v1/node/services/nsx-platform-client
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client
System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client
Restart, start or stop the NSX Platform Client service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client?action=restart|start|stop
POST /api/v1/node/services/nsx-platform-client?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client
Read NSX Platform Client service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client/status
GET /api/v1/node/services/nsx-platform-client/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client/status
System Administration > Configuration > Fabric > Nodes > Services > NTP
Read NTP service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp
GET /api/v1/cluster/<cluster-node-id>/node/services/ntp
GET /api/v1/node/services/ntp
System Administration > Configuration > Fabric > Nodes > Services > NTP
Restart, start or stop the NTP service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ntp?action=restart|start|stop
POST /api/v1/node/services/ntp?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/ntp?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > NTP
Update NTP service properties
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ntp
PUT /api/v1/cluster/<cluster-node-id>/node/services/ntp
PUT /api/v1/node/services/ntp
System Administration > Configuration > Fabric > Nodes > Services > NTP
Read NTP service status
GET /api/v1/cluster/<cluster-node-id>/node/services/ntp/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp/status
GET /api/v1/node/services/ntp/status
System Administration > Configuration > Fabric > Nodes > Services > Node Management
Read appliance management service properties
GET /api/v1/node/services/node-mgmt
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt
GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt
System Administration > Configuration > Fabric > Nodes > Services > Node Management
Restart the node management service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt?action=restart
POST /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt?action=restart
POST /api/v1/node/services/node-mgmt?action=restart
System Administration > Configuration > Fabric > Nodes > Services > Node Management
Read appliance management service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt/status
GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt/status
GET /api/v1/node/services/node-mgmt/status
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Read SNMP service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp
GET /api/v1/node/services/snmp
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Restart, start or stop the SNMP service
POST /api/v1/cluster/<cluster-node-id>/node/services/snmp?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/snmp?action=restart|start|stop
POST /api/v1/node/services/snmp?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Update SNMP service properties
PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp
PUT /api/v1/node/services/snmp
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Read SNMP service status
GET /api/v1/node/services/snmp/status
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/status
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Read SNMP V3 Engine ID
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id
GET /api/v1/node/services/snmp/v3-engine-id
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
System Administration > Configuration > Fabric > Nodes > Services > SNMP
Update SNMP V3 Engine ID
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id
PUT /api/v1/node/services/snmp/v3-engine-id
PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
System Administration > Configuration > Fabric > Nodes > Services > SSH
Read ssh service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh
GET /api/v1/node/services/ssh
System Administration > Configuration > Fabric > Nodes > Services > SSH
Restart, start or stop the ssh service
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=start|stop|restart
POST /api/v1/node/services/ssh?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > Services > SSH
Remove a host's fingerprint from known hosts file
POST /api/v1/node/services/ssh?action=remove_host_fingerprint
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=remove_host_fingerprint
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=remove_host_fingerprint
System Administration > Configuration > Fabric > Nodes > Services > SSH
Update ssh service properties
PUT /api/v1/cluster/<cluster-node-id>/node/services/ssh
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ssh
PUT /api/v1/node/services/ssh
System Administration > Configuration > Fabric > Nodes > Services > SSH
Restart, start or stop the ssh service
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh/notify_mpa?action=start|stop|restart
POST /api/v1/node/services/ssh/notify_mpa?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/notify_mpa?action=start|stop|restart
System Administration > Configuration > Fabric > Nodes > Services > SSH
Read ssh service status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh/status
GET /api/v1/node/services/ssh/status
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Read syslog service properties
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog
GET /api/v1/node/services/syslog
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Restart, start or stop the syslog service
POST /api/v1/node/services/syslog?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Delete all node syslog exporters
DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
DELETE /api/v1/node/services/syslog/exporters
DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
System Administration > Configuration > Fabric > Nodes > Services > Syslog
List node syslog exporters
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
GET /api/v1/node/services/syslog/exporters
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Verify node syslog exporter
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters?action=verify
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters?action=verify
POST /api/v1/node/services/syslog/exporters?action=verify
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Add node syslog exporter
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
POST /api/v1/node/services/syslog/exporters
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Delete node syslog exporter
DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
DELETE /api/v1/node/services/syslog/exporters/<exporter-name>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name>
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Read node syslog exporter
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
GET /api/v1/node/services/syslog/exporters/<exporter-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name>
System Administration > Configuration > Fabric > Nodes > Services > Syslog
Read syslog service status
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/status
GET /api/v1/node/services/syslog/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/status
System Administration > Configuration > Fabric > Nodes > Services > Tasks
List appliance management tasks
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks
GET /api/v1/node/tasks
GET /api/v1/cluster/<cluster-node-id>/node/tasks
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Delete task
DELETE /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
DELETE /api/v1/node/tasks/<task-id>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Read task properties
GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
GET /api/v1/node/tasks/<task-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Cancel specified task
POST /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>?action=cancel
POST /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>?action=cancel
POST /api/v1/node/tasks/<task-id>?action=cancel
System Administration > Configuration > Fabric > Nodes > Services > Tasks
Read asynchronous task response
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>/response
GET /api/v1/node/tasks/<task-id>/response
GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>/response
System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent
Read NSX upgrade Agent service properties
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent
GET /api/v1/node/services/nsx-upgrade-agent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent
System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent
Restart, start or stop the NSX upgrade agent service
POST /api/v1/node/services/nsx-upgrade-agent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent?action=restart|start|stop
System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent
Read Nsx upgrade agent service status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent/status
GET /api/v1/node/services/nsx-upgrade-agent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent/status
System Administration > Configuration > Fabric > Nodes > Settings
Read node properties
GET /api/v1/node
GET /api/v1/cluster/<cluster-node-id>/node
GET /api/v1/transport-nodes/<transport-node-id>/node
System Administration > Configuration > Fabric > Nodes > Settings
Restart or shutdown node
POST /api/v1/transport-nodes/<transport-node-id>/node?action=restart|shutdown
POST /api/v1/node?action=restart|shutdown
POST /api/v1/cluster/<cluster-node-id>/node?action=restart|shutdown
System Administration > Configuration > Fabric > Nodes > Settings
Set the node system time
POST /api/v1/transport-nodes/<transport-node-id>/node?action=set_system_time
POST /api/v1/cluster/<cluster-node-id>/node?action=set_system_time
POST /api/v1/node?action=set_system_time
System Administration > Configuration > Fabric > Nodes > Settings
Update node properties
PUT /api/v1/node
PUT /api/v1/cluster/<cluster-node-id>/node
PUT /api/v1/transport-nodes/<transport-node-id>/node
System Administration > Configuration > Fabric > Nodes > Settings
List node processes
GET /api/v1/cluster/<cluster-node-id>/node/processes
GET /api/v1/transport-nodes/<transport-node-id>/node/processes
GET /api/v1/node/processes
System Administration > Configuration > Fabric > Nodes > Settings
Read node process
GET /api/v1/cluster/<cluster-node-id>/node/processes/<process-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/processes/<process-id>
GET /api/v1/node/processes/<process-id>
System Administration > Configuration > Fabric > Nodes > Settings
Read node status
GET /api/v1/transport-nodes/<transport-node-id>/node/status
GET /api/v1/node/status
GET /api/v1/cluster/<cluster-node-id>/node/status
System Administration > Configuration > Fabric > Nodes > Settings
Update node status
POST /api/v1/transport-nodes/<transport-node-id>/node/status?action=clear_bootup_error
POST /api/v1/cluster/<cluster-node-id>/node/status?action=clear_bootup_error
POST /api/v1/node/status?action=clear_bootup_error
System Administration > Configuration > Fabric > Nodes > Settings
Read node version
GET /api/v1/transport-nodes/<transport-node-id>/node/version
GET /api/v1/node/version
GET /api/v1/cluster/<cluster-node-id>/node/version
System Administration > Configuration > Fabric > Nodes > Support-Bundle
Read node support bundle
GET /api/v1/cluster/<cluster-node-id>/node/support-bundle
GET /api/v1/node/support-bundle
GET /api/v1/transport-nodes/<transport-node-id>/node/support-bundle
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
List Transport Node collections
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Detach transport node profile from compute collection.
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collection-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Get Transport Node collection by id
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collection-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Patch Transport Node collection
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collection-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Retry the process on applying transport node profile
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collection-id>?action=retry_profile_realization
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Uninstall NSX from the specified Transport Node Collection
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collection-id>?action=remove_nsx
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Configure the cluster for security
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collection-id>?action=install_for_microseg
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Get Transport Node collection application state
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collection-id>/state
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Create transport node collection by attaching Transport Node Profile to cluster.
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-node-collections/<transport-node-collections-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
List Transport Node collections
GET /api/v1/transport-node-collections
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Create transport node collection by attaching Transport Node Profile to cluster.
POST /api/v1/transport-node-collections
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Detach transport node profile from compute collection.
DELETE /api/v1/transport-node-collections/<transport-node-collection-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Get Transport Node collection by id
GET /api/v1/transport-node-collections/<transport-node-collection-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Retry the process on applying transport node profile
POST /api/v1/transport-node-collections/<transport-node-collection-id>?action=retry_profile_realization
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Update Transport Node collection
PUT /api/v1/transport-node-collections/<transport-node-collection-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Collections
Get Transport Node collection application state
GET /api/v1/transport-node-collections/<transport-node-collection-id>/state
System Administration > Configuration > Fabric > Nodes > Transport Node Interfaces
List the specified node's Network Interfaces
GET /api/v1/fabric/nodes/<node-id>/network/interfaces (Deprecated)
System Administration > Configuration > Fabric > Nodes > Transport Node Interfaces
List the specified transport node's network interfaces
GET /api/v1/transport-nodes/<transport-node-id>/network/interfaces
System Administration > Configuration > Fabric > Nodes > Transport Node Interfaces
Read the transport node's network interface
GET /api/v1/transport-nodes/<transport-node-id>/network/interfaces/<interface-id>
System Administration > Configuration > Fabric > Nodes > Transport Node Interfaces
Read the NSX Manager's Network Interface Statistics
GET /api/v1/transport-nodes/<transport-node-id>/network/interfaces/<interface-id>/stats
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Get high-level summary of a transport node
GET /api/v1/transport-nodes/<node-id>/pnic-bond-status
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Read status of all transport nodes with tunnel connections to transport node
GET /api/v1/transport-nodes/<node-id>/remote-transport-node-status
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Read status of a transport node
GET /api/v1/transport-nodes/<node-id>/status
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.
GET /api/v1/transport-nodes/status
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Read status of transport nodes in a transport zone
GET /api/v1/transport-zones/<zone-id>/transport-node-status
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Creates a status report of transport nodes in a transport zone
GET /api/v1/transport-zones/<zone-id>/transport-node-status-report
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Read status of all the transport nodes
GET /api/v1/transport-zones/transport-node-status
System Administration > Configuration > Fabric > Nodes > Transport Node Status
Creates a status report of transport nodes of all the transport zones
GET /api/v1/transport-zones/transport-node-status-report
System Administration > Configuration > Fabric > Nodes > Transport Node Tunnels
List of tunnels
GET /api/v1/transport-nodes/<node-id>/tunnels
System Administration > Configuration > Fabric > Nodes > Transport Node Tunnels
Tunnel properties
GET /api/v1/transport-nodes/<node-id>/tunnels/<tunnel-name>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
List Host Transport Nodes
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Delete a Transport Node
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Get a Host Transport Node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Patch a Host Transport Node
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Update transport node maintenance mode
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Trigger Migration of NVDS to VDS on this TransportNode.
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>?action=migrate_to_vds
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Resync a Host Transport Node
POST /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>?action=resync_host_config
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Apply cluster level Transport Node Profile on overridden host
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>?action=restore_cluster_config
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Create or update a Host Transport Node
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Fetch Discovered VIF State on given TransportNode
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/discovered-vifs
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Get the module details of a host transport node
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/modules
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Get a Host Transport Node's State
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/state
System Administration > Configuration > Fabric > Nodes > Transport Nodes
List transport nodes by realized state
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/state
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Clean up all nvds upgrade related configurations
POST /api/v1/nvds-urt?action=cleanup
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Set the migrate status key of ExtraConfigProfile of all Transport Nodes to IGNORE
POST /api/v1/nvds-urt?action=ignore_migrate_status
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Retrieve latest precheck ID of the N-VDS to VDS migration
GET /api/v1/nvds-urt/precheck
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Start precheck for N-VDS to VDS migration
POST /api/v1/nvds-urt/precheck
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Start precheck for N-VDS to VDS migration by clusters
POST /api/v1/nvds-urt/precheck-by-clusters
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Get summary of N-VDS to VDS migration
GET /api/v1/nvds-urt/status-summary/<precheck-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Set VDS configuration and create it in vCenter
POST /api/v1/nvds-urt/topology?action=apply
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Recommmended topology
GET /api/v1/nvds-urt/topology/<precheck-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
List Transport Nodes
GET /api/v1/transport-nodes
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Create a Transport Node
POST /api/v1/transport-nodes
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Clear edge transport node stale entries
POST /api/v1/transport-nodes?action=clean_stale_entries
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Redeploys a new node that replaces the specified edge node.
POST /api/v1/transport-nodes/<node-id>?action=redeploy
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Get the module details of a transport node This api is now deprecated. Please use new api - /infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/modules
GET /api/v1/transport-nodes/<node-id>/modules (Deprecated)
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke DELETE request on target transport node
DELETE /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke GET request on target transport node
GET /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke POST request on target transport node
POST /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Invoke PUT request on target transport node
PUT /api/v1/transport-nodes/<target-node-id>/<target-uri>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Delete a Transport Node
DELETE /api/v1/transport-nodes/<transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Get a Transport Node
GET /api/v1/transport-nodes/<transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Apply cluster level Transport Node Profile on overridden host
POST /api/v1/transport-nodes/<transport-node-id>?action=restore_cluster_config (Deprecated)
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Enable flow cache for an edge transport node
POST /api/v1/transport-nodes/<transport-node-id>?action=enable_flow_cache
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Refresh the node configuration for the Edge node.
POST /api/v1/transport-nodes/<transport-node-id>?action=refresh_node_configuration&resource_type=EdgeNode
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Restart the inventory sync for the node if it is paused currently.
POST /api/v1/transport-nodes/<transport-node-id>?action=restart_inventory_sync
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Disable flow cache for an edge transport node
POST /api/v1/transport-nodes/<transport-node-id>?action=disable_flow_cache
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Trigger Migration of NVDS to VDS on this TransportNode.
POST /api/v1/transport-nodes/<transport-node-id>?action=migrate_to_vds (Deprecated)
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Update a Transport Node
PUT /api/v1/transport-nodes/<transport-node-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Return the list of capabilities of transport node
GET /api/v1/transport-nodes/<transport-node-id>/capabilities
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Get a Transport Node's State
GET /api/v1/transport-nodes/<transport-node-id>/state
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Resync a Transport Node
POST /api/v1/transport-nodes/<transportnode-id>?action=resync_host_config
System Administration > Configuration > Fabric > Nodes > Transport Nodes
Update transport node maintenance mode
POST /api/v1/transport-nodes/<transportnode-id>
System Administration > Configuration > Fabric > Nodes > Transport Nodes
List transport nodes by realized state
GET /api/v1/transport-nodes/state
System Administration > Configuration > Fabric > Nodes > User Management > Authentication Policy
Read node authentication policy configuration
GET /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy
GET /api/v1/node/aaa/auth-policy
GET /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy
System Administration > Configuration > Fabric > Nodes > User Management > Authentication Policy
Update node authentication policy configuration
PUT /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy
PUT /api/v1/node/aaa/auth-policy
PUT /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy
System Administration > Configuration > Fabric > Nodes > User Management > Users
List node users
GET /api/v1/transport-nodes/<transport-node-id>/node/users
GET /api/v1/cluster/<cluster-node-id>/node/users
GET /api/v1/node/users
System Administration > Configuration > Fabric > Nodes > User Management > Users
Reset a user's own password. Requires current password
POST /api/v1/node/users?action=reset_own_password
POST /api/v1/cluster/<cluster-node-id>/node/users?action=reset_own_password
System Administration > Configuration > Fabric > Nodes > User Management > Users
Read node user
GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>
GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>
GET /api/v1/node/users/<userid>
System Administration > Configuration > Fabric > Nodes > User Management > Users
Activate a user account with a password
POST /api/v1/node/users/<userid>?action=activate
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>?action=activate
System Administration > Configuration > Fabric > Nodes > User Management > Users
Reset a user's password without requiring their current password
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>?action=reset_password
POST /api/v1/node/users/<userid>?action=reset_password
System Administration > Configuration > Fabric > Nodes > User Management > Users
Deactivate a user account
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>?action=deactivate
POST /api/v1/node/users/<userid>?action=deactivate
System Administration > Configuration > Fabric > Nodes > User Management > Users
Update node user
PUT /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>
PUT /api/v1/cluster/<cluster-node-id>/node/users/<userid>
PUT /api/v1/node/users/<userid>
System Administration > Configuration > Fabric > Nodes > User Management > Users
List SSH keys from authorized_keys file for node user
GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys
GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys
GET /api/v1/node/users/<userid>/ssh-keys
System Administration > Configuration > Fabric > Nodes > User Management > Users
Remove SSH public key from authorized_keys file for node user
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key
POST /api/v1/node/users/<userid>/ssh-keys?action=remove_ssh_key
System Administration > Configuration > Fabric > Nodes > User Management > Users
Add SSH public key to authorized_keys file for node user
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key
POST /api/v1/node/users/<userid>/ssh-keys?action=add_ssh_key
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Returns list of configured IP address blocks.
GET /api/v1/pools/ip-blocks
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Create a new IP address block.
POST /api/v1/pools/ip-blocks
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Delete an IP Address Block
DELETE /api/v1/pools/ip-blocks/<block-id>
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Get IP address block information.
GET /api/v1/pools/ip-blocks/<block-id>
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Update an IP Address Block
PUT /api/v1/pools/ip-blocks/<block-id>
System Administration > Configuration > Fabric > Pool Management > IP Blocks
List subnets within an IP block
GET /api/v1/pools/ip-subnets
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Create subnet of specified size within an IP block
POST /api/v1/pools/ip-subnets
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Delete subnet within an IP block
DELETE /api/v1/pools/ip-subnets/<subnet-id>
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Get the subnet within an IP block
GET /api/v1/pools/ip-subnets/<subnet-id>
System Administration > Configuration > Fabric > Pool Management > IP Blocks
Allocate or Release an IP Address from a Ip Subnet
POST /api/v1/pools/ip-subnets/<subnet-id>
System Administration > Configuration > Fabric > Pool Management > IP Pools
List IP Pools
GET /api/v1/pools/ip-pools
System Administration > Configuration > Fabric > Pool Management > IP Pools
Create an IP Pool
POST /api/v1/pools/ip-pools
System Administration > Configuration > Fabric > Pool Management > IP Pools
Delete an IP Pool
DELETE /api/v1/pools/ip-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > IP Pools
Read IP Pool
GET /api/v1/pools/ip-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > IP Pools
Allocate or Release an IP Address from a Pool
POST /api/v1/pools/ip-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > IP Pools
Update an IP Pool
PUT /api/v1/pools/ip-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > IP Pools
List IP Pool Allocations
GET /api/v1/pools/ip-pools/<pool-id>/allocations
System Administration > Configuration > Fabric > Pool Management > MAC Pools
List MAC Pools
GET /api/v1/pools/mac-pools
System Administration > Configuration > Fabric > Pool Management > MAC Pools
Read MAC Pool
GET /api/v1/pools/mac-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > VNI Pools
List VNI Pools
GET /api/v1/pools/vni-pools
System Administration > Configuration > Fabric > Pool Management > VNI Pools
Create a new VNI Pool.
POST /api/v1/pools/vni-pools
System Administration > Configuration > Fabric > Pool Management > VNI Pools
Delete a VNI Pool
DELETE /api/v1/pools/vni-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > VNI Pools
Read VNI Pool
GET /api/v1/pools/vni-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > VNI Pools
Update a VNI Pool
PUT /api/v1/pools/vni-pools/<pool-id>
System Administration > Configuration > Fabric > Pool Management > VTEP Label Pools
List virtual tunnel endpoint Label Pools
GET /api/v1/pools/vtep-label-pools
System Administration > Configuration > Fabric > Pool Management > VTEP Label Pools
Read a virtual tunnel endpoint label pool
GET /api/v1/pools/vtep-label-pools/<pool-id>
System Administration > Configuration > Fabric > Profiles > Cluster Profiles
List Cluster Profiles
GET /api/v1/cluster-profiles
System Administration > Configuration > Fabric > Profiles > Cluster Profiles
Create a Cluster Profile
POST /api/v1/cluster-profiles
System Administration > Configuration > Fabric > Profiles > Cluster Profiles
Delete a cluster profile
DELETE /api/v1/cluster-profiles/<cluster-profile-id>
System Administration > Configuration > Fabric > Profiles > Cluster Profiles
Get cluster profile by Id
GET /api/v1/cluster-profiles/<cluster-profile-id>
System Administration > Configuration > Fabric > Profiles > Cluster Profiles
Update a cluster profile
PUT /api/v1/cluster-profiles/<cluster-profile-id>
System Administration > Configuration > Fabric > Profiles > Host Transport Node Profiles
List Host Transport Nodes
GET /policy/api/v1/infra/host-transport-node-profiles
System Administration > Configuration > Fabric > Profiles > Host Transport Node Profiles
Get a Transport Node
GET /policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>
System Administration > Configuration > Fabric > Profiles > Host Transport Node Profiles
Delete a Host Transport Node Profile
DELETE /policy/api/v1/infra/host-transport-node-profiles/<transport-node-profile-id>
System Administration > Configuration > Fabric > Profiles > Host Transport Node Profiles
Update a Host Transport Node Profile
PUT /policy/api/v1/infra/host-transport-node-profiles/<transport-node-profile-id>
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
List Hostswitch Profiles
GET /api/v1/host-switch-profiles (Deprecated)
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Create a Hostswitch Profile
POST /api/v1/host-switch-profiles (Deprecated)
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Delete a Hostswitch Profile
DELETE /api/v1/host-switch-profiles/<host-switch-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Get a Hostswitch Profile by ID
GET /api/v1/host-switch-profiles/<host-switch-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Update a Hostswitch Profile
PUT /api/v1/host-switch-profiles/<host-switch-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
List Hostswitch Profiles
GET /policy/api/v1/infra/host-switch-profiles
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Delete a Hostswitch Profile
DELETE /policy/api/v1/infra/host-switch-profiles/<host-switch-profile-id>
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Get a Hostswitch Profile by ID
GET /policy/api/v1/infra/host-switch-profiles/<host-switch-profile-id>
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Create or update a Hostswitch Profile
PATCH /policy/api/v1/infra/host-switch-profiles/<host-switch-profile-id>
System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles
Create or update a Hostswitch Profile
PUT /policy/api/v1/infra/host-switch-profiles/<host-switch-profile-id>
System Administration > Configuration > Fabric > Profiles > Transport Node Profiles
List Transport Nodes
GET /api/v1/transport-node-profiles (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Node Profiles
Create a Transport Node Profile
POST /api/v1/transport-node-profiles (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Node Profiles
Delete a Transport Node Profile
DELETE /api/v1/transport-node-profiles/<transport-node-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Node Profiles
Get a Transport Node
GET /api/v1/transport-node-profiles/<transport-node-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Node Profiles
Update a Transport Node Profile
PUT /api/v1/transport-node-profiles/<transport-node-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Zone Profiles
List transport zone profiles
GET /api/v1/transportzone-profiles (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Zone Profiles
Create a transport zone Profile
POST /api/v1/transportzone-profiles (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Zone Profiles
Delete a transport zone Profile
DELETE /api/v1/transportzone-profiles/<transportzone-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Zone Profiles
Get transport zone profile by identifier
GET /api/v1/transportzone-profiles/<transportzone-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Profiles > Transport Zone Profiles
Update a transport zone profile
PUT /api/v1/transportzone-profiles/<transportzone-profile-id> (Deprecated)
System Administration > Configuration > Fabric > Transport Zones
List Transport Zones
GET /api/v1/transport-zones (Deprecated)
System Administration > Configuration > Fabric > Transport Zones
Create a Transport Zone
POST /api/v1/transport-zones (Deprecated)
System Administration > Configuration > Fabric > Transport Zones
Delete a Transport Zone
DELETE /api/v1/transport-zones/<zone-id> (Deprecated)
System Administration > Configuration > Fabric > Transport Zones
Get a Transport Zone
GET /api/v1/transport-zones/<zone-id> (Deprecated)
System Administration > Configuration > Fabric > Transport Zones
Update a Transport Zone
PUT /api/v1/transport-zones/<zone-id> (Deprecated)
System Administration > Configuration > Fabric > Transport Zones
Get high-level summary of a transport zone
GET /api/v1/transport-zones/<zone-id>/status
System Administration > Configuration > Fabric > Transport Zones
Get a Transport Zone's Current Runtime Status Information
GET /api/v1/transport-zones/<zone-id>/summary (Deprecated)
System Administration > Configuration > Fabric > Transport Zones
Get high-level summary of a transport zone. The service layer does not support source = realtime or cached.
GET /api/v1/transport-zones/status
System Administration > Configuration > Global Configurations
List all Central Node Config profiles
GET /api/v1/configs/central-config/node-config-profiles
System Administration > Configuration > Global Configurations
Configure Node Config profile
PUT /api/v1/configs/central-config/node-config-profiles/<node-config-profile-id>
System Administration > Configuration > Global Configurations
Read Central Node Config profile
GET /api/v1/configs/central-config/node-config-profiles/<profile-id>
System Administration > Configuration > Global Configurations
List global configurations of a NSX domain
GET /api/v1/global-configs
System Administration > Configuration > Global Configurations
Get global configs for a config type
GET /api/v1/global-configs/<config-type>
System Administration > Configuration > Global Configurations
Resyncs global configurations of a config-type
PUT /api/v1/global-configs/<config-type>?action=resync_config
System Administration > Configuration > Global Configurations
Update global configurations of a config type
PUT /api/v1/global-configs/<config-type>
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Cluster
Returns information for Advanced Load Balancer controller cluster
GET /policy/api/v1/alb/controller-nodes/cluster
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Cluster
Re-trigger clustering for Advanced Load Balancer Nodes.
PUT /policy/api/v1/alb/controller-nodes/cluster
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Cluster Config
Returns info for of the cluster configuration for the Advanced Load Balancer controller cluster
GET /policy/api/v1/alb/controller-nodes/clusterconfig
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Cluster Config
Set the cluster configuration for the Advanced Load Balancer controller VM. The VIP can be set once. Attempting to change the VIP once set will return an error.
POST /policy/api/v1/alb/controller-nodes/clusterconfig
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Deployments
Returns info for all cluster node VM auto-deployment attempts
GET /policy/api/v1/alb/controller-nodes/deployments
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Deployments
Deploy and register a Advanced Load Balancer controller node VM
POST /policy/api/v1/alb/controller-nodes/deployments
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Deployments
Returns info for a Advanced Load Balancer controller deployment attempt
GET /policy/api/v1/alb/controller-nodes/deployments/<node-id>
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Deployments
Attempt to delete an auto-deployed Advanced Load Balancer controller node
POST /policy/api/v1/alb/controller-nodes/deployments/<node-id>?action=delete
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Deployments
Update a Advanced Load Balancer controller cluster node VM. Only updating password, ntp and dns servers are supported. If controller is in a cluster then all nodes in the cluster are updated with the provided values
PUT /policy/api/v1/alb/controller-nodes/deployments/<node-id>
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Deployments
Returns the status of the VM creation/deletion
GET /policy/api/v1/alb/controller-nodes/deployments/<node-id>/status
System Administration > Configuration > NSX Advanced Load Balancer > Controller > Form Factors
List available Advanced Load Balancer controller form factors
GET /policy/api/v1/alb/controller-nodes/form-factors
System Administration > Configuration > NSX Intelligence > Deployments
Returns info for all cluster node VM auto-deployment attempts
GET /api/v1/intelligence/nodes/deployments
System Administration > Configuration > NSX Intelligence > Deployments
Deploy and register a Intelligence cluster node VM
POST /api/v1/intelligence/nodes/deployments (Deprecated)
System Administration > Configuration > NSX Intelligence > Deployments
Returns info for a Intelligence cluster node VM auto-deployment attempt
GET /api/v1/intelligence/nodes/deployments/<node-id>
System Administration > Configuration > NSX Intelligence > Deployments
Attempt to delete an auto-deployed cluster node VM
POST /api/v1/intelligence/nodes/deployments/<node-id>?action=delete
System Administration > Configuration > NSX Intelligence > Deployments
Returns the status of the VM creation/deletion
GET /api/v1/intelligence/nodes/deployments/<node-id>/status
System Administration > Configuration > NSX Intelligence > Form Factors
List available Napp appliance form factors
GET /api/v1/node/intelligence/form-factors (Deprecated)
GET /api/v1/cluster/<cluster-node-id>/node/intelligence/form-factors (Deprecated)
System Administration > Configuration > NSX Intelligence > Host
Get NSX-Intelligence host configuration
GET /api/v1/intelligence/host-config (Deprecated)
System Administration > Configuration > NSX Intelligence > Host
Patch NSX-Intelligence host configuration
PATCH /api/v1/intelligence/host-config (Deprecated)
System Administration > Configuration > NSX Intelligence > Host
Reset NSX-Intelligence host configuration
POST /api/v1/intelligence/host-config?action=reset (Deprecated)
System Administration > Configuration > NSX Intelligence > Repository > Bundles
Get list of bundle-ids which are available in repository or in-progress
GET /api/v1/repository/bundles
System Administration > Configuration > NSX Intelligence > Repository > Bundles
Upload bundle using remote file
POST /api/v1/repository/bundles
System Administration > Configuration > NSX Intelligence > Repository > Bundles
Upload bundle
POST /api/v1/repository/bundles?action=upload
System Administration > Configuration > NSX Intelligence > Repository > Bundles
Cancel bundle upload
POST /api/v1/repository/bundles/<bundle-id>?action=cancel_upload
System Administration > Configuration > NSX Intelligence > Repository > Bundles
Get bundle upload status
GET /api/v1/repository/bundles/<bundle-id>/upload-status
System Administration > Configuration > NSX Intelligence > Repository > Bundles
Get information of the OVF which will be getting deployed.
GET /api/v1/repository/bundles/ovf-deploy-info
System Administration > Configuration > NSX Intelligence > Repository > Bundles
Checks bundle upload permissions
GET /api/v1/repository/bundles/upload-allowed
System Administration > Configuration > NSX Managers > API Services > API Request Batching
Register a Collection of API Calls at a Single End Point
POST /policy/api/v1/batch
POST /api/v1/batch
System Administration > Configuration > NSX Managers > API Services > Configuration
Read API service properties
GET /api/v1/cluster/api-service
System Administration > Configuration > NSX Managers > API Services > Configuration
Update API service properties
PUT /api/v1/cluster/api-service
System Administration > Configuration > NSX Managers > API Services > Task Management
Get information about all tasks
GET /policy/api/v1/tasks
GET /api/v1/tasks
System Administration > Configuration > NSX Managers > API Services > Task Management
Get information about the specified task
GET /policy/api/v1/tasks/<task-id>
GET /api/v1/tasks/<task-id>
System Administration > Configuration > NSX Managers > API Services > Task Management
Get the response of a task
GET /policy/api/v1/tasks/<task-id>/response
GET /api/v1/tasks/<task-id>/response
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
Read cluster certificate ID
GET /api/v1/cluster/api-certificate
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
Clear the cluster certificate
POST /api/v1/cluster/api-certificate?action=clear_cluster_certificate (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
Set the cluster certificate
POST /api/v1/cluster/api-certificate?action=set_cluster_certificate
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Read Cluster Configuration
GET /api/v1/cluster
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Join this node to a NSX Cluster
POST /api/v1/cluster?action=join_cluster
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Read cluster node configuration
GET /api/v1/cluster/<node-id>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Detach a node from the Cluster
POST /api/v1/cluster/<node-id>?action=remove_node
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke DELETE request on target cluster node
DELETE /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke GET request on target cluster node
GET /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke POST request on target cluster node
POST /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Invoke PUT request on target cluster node
PUT /api/v1/cluster/<target-node-id>/<target-uri>
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Get backup frames for UI
GET /api/v1/cluster/backups/ui_frames
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
List Cluster Node Configurations
GET /api/v1/cluster/nodes
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Add a controller to the cluster
POST /api/v1/cluster/nodes (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Remove a controller from the cluster
DELETE /api/v1/cluster/nodes/<node-id> (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Configuration
Read Cluster Node Configuration
GET /api/v1/cluster/nodes/<node-id> (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Interfaces
List the specified node's Network Interfaces
GET /api/v1/cluster/nodes/<node-id>/network/interfaces
System Administration > Configuration > NSX Managers > Clusters > Cluster Interfaces
Read the node's Network Interface
GET /api/v1/cluster/nodes/<node-id>/network/interfaces/<interface-id>
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments
Synchronizes the repository data between nsx managers.
POST /api/v1/cluster/node?action=repo_sync
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments
Synchronizes the repository data between nsx managers.
GET /api/v1/cluster/nodes/<node-id>/repo_sync/status
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments
Returns info for all cluster node VM auto-deployment attempts
GET /api/v1/cluster/nodes/deployments
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments
Deploy and register a cluster node VM
POST /api/v1/cluster/nodes/deployments
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments
Returns info for a cluster-node VM auto-deployment attempt
GET /api/v1/cluster/nodes/deployments/<node-id>
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments
Attempt to delete an auto-deployed cluster node VM
POST /api/v1/cluster/nodes/deployments/<node-id>?action=delete
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments
Returns the status of the VM creation/deletion
GET /api/v1/cluster/nodes/deployments/<node-id>/status
System Administration > Configuration > NSX Managers > Clusters > Cluster Status
Read cluster node runtime status
GET /api/v1/cluster/nodes/<node-id>/status
System Administration > Configuration > NSX Managers > Clusters > Cluster Status
Read cluster runtime status
GET /api/v1/cluster/nodes/status (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Status
Read Cluster Status
GET /api/v1/cluster/status
System Administration > Configuration > NSX Managers > Clusters > Cluster Virtual IP
Read cluster virtual IP address
GET /api/v1/cluster/api-virtual-ip
System Administration > Configuration > NSX Managers > Clusters > Cluster Virtual IP
Clear cluster virtual IP address
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip
System Administration > Configuration > NSX Managers > Clusters > Cluster Virtual IP
Set cluster virtual IP address
POST /api/v1/cluster/api-virtual-ip?action=set_virtual_ip
System Administration > Configuration > NSX Managers > Manager Configuration
Read NSX Management nodes global configuration.
GET /policy/api/v1/configs/management
GET /api/v1/configs/management
System Administration > Configuration > NSX Managers > Manager Configuration
Update NSX Management nodes global configuration
PUT /policy/api/v1/configs/management
PUT /api/v1/configs/management
System Administration > Configuration > NSX Managers > Manager Mode
NodeMode
POST /api/v1/configs/node/mode
System Administration > Configuration > NSX Managers > Nodes > Services > Async Replicator Service
Update the async_replicator service properties
PUT /api/v1/node/services/async_replicator
PUT /api/v1/cluster/<cluster-node-id>/node/services/async_replicator
System Administration > Configuration > NSX Partial Patch
Fetch the policy partial patch configuration value.
GET /policy/api/v1/system-config/nsx-partial-patch-config
System Administration > Configuration > NSX Partial Patch
Saves the configuration for policy partial patch
PATCH /policy/api/v1/system-config/nsx-partial-patch-config
System Administration > Configuration > Nodes > Manager Configuration
Read Central Config properties
GET /api/v1/node/central-config
GET /api/v1/cluster/<cluster-node-id>/node/central-config
System Administration > Configuration > Nodes > Manager Configuration
Update Central Config properties
PUT /api/v1/node/central-config
PUT /api/v1/cluster/<cluster-node-id>/node/central-config
System Administration > Configuration > Site Management
Get the site configuration
GET /api/v1/sites
System Administration > Configuration > Site Management
Get the site configuration, some attributes won't be shown based on version
GET /api/v1/sites?version=3.0.2|3.1.0|latest
System Administration > Configuration > Site Management
Get the compatibility list of the site
GET /api/v1/sites/compatibility
System Administration > Configuration > Site Management
Check whether the remote site version is compatible to this site
GET /api/v1/sites/compatibility/remote
System Administration > Configuration > Site Management
Get the local site configuration
GET /api/v1/sites/self
System Administration > Configuration > Site Management
Get overall status of the federation, including stub status
GET /api/v1/sites/status
System Administration > Configuration > Site Management
Get the switchover status
GET /api/v1/sites/switchover-status
System Administration > Configuration > System Properties > Dataplane
Get NSX Edge dataplane geneve cbit setting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/geneve-cbit
System Administration > Configuration > System Properties > Dataplane
Update NSX Edge dataplane geneve cbit setting
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/geneve-cbit
System Administration > Configuration > System Properties > IPSEC Sessions
Get NSX Edge IPSec Determ RSS setting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/vpn/ipsec/deterministic-esp-rss
System Administration > Configuration > System Properties > IPSEC Sessions
Update NSX Edge IPSec Determ RSS setting
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/vpn/ipsec/deterministic-esp-rss
System Administration > Configuration > System Properties > IPSEC Sessions
Get NSX Edge IPSec Determ RSS setting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/vpn/ipsec/deterministic-esp-rss/status
System Administration > Configuration > System Properties > Mpa Configuration
Delete MPA configuration for this node
DELETE /api/v1/node/mpa-config
DELETE /api/v1/cluster/<cluster-node-id>/node/mpa-config
System Administration > Configuration > System Properties > Mpa Configuration
Get MPA configuration for this node
GET /api/v1/node/mpa-config (Experimental)
GET /api/v1/cluster/<cluster-node-id>/node/mpa-config (Experimental)
System Administration > Configuration > System Properties > Mpa Configuration
Update MPA configuration for this node
PUT /api/v1/node/mpa-config (Experimental)
PUT /api/v1/cluster/<cluster-node-id>/node/mpa-config (Experimental)
System Administration > Configuration > System Properties > Mpa Configuration
Update management plane agent configuration and restart MPA
PUT /api/v1/transport-nodes/<transport-node-id>/node/mpa-config?action=restart (Experimental)
System Administration > Configuration > System Properties > Pcg Registration
Get PCG registration payload
GET /api/v1/pcg-registration-payload
System Administration > Configuration > System Properties > Realization State Barrier
Gets the realization state barrier configuration
GET /api/v1/realization-state-barrier/config
System Administration > Configuration > System Properties > Realization State Barrier
Updates the barrier configuration
PUT /api/v1/realization-state-barrier/config
System Administration > Configuration > System Properties > Realization State Barrier
Gets the current barrier number
GET /api/v1/realization-state-barrier/current (Deprecated)
System Administration > Configuration > System Properties > Realization State Barrier
Increments the barrier count by 1
POST /api/v1/realization-state-barrier/current?action=increment (Deprecated)
System Administration > Lifecycle Management > Backup Restore Management > Backup
Request one-time inventory summary.
POST /policy/api/v1/cluster?action=summarize_inventory_to_remote
POST /api/v1/cluster?action=summarize_inventory_to_remote
System Administration > Lifecycle Management > Backup Restore Management > Backup
Request one-time backup
POST /policy/api/v1/cluster?action=backup_to_remote
POST /api/v1/cluster?action=backup_to_remote
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get ssh fingerprint of remote(backup) server
POST /policy/api/v1/cluster/backups?action=retrieve_ssh_fingerprint
POST /api/v1/cluster/backups?action=retrieve_ssh_fingerprint
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get backup configuration
GET /policy/api/v1/cluster/backups/config
GET /api/v1/cluster/backups/config
System Administration > Lifecycle Management > Backup Restore Management > Backup
Configure backup
PUT /policy/api/v1/cluster/backups/config
PUT /api/v1/cluster/backups/config
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get backup history
GET /policy/api/v1/cluster/backups/history
GET /api/v1/cluster/backups/history
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get all backup related information for a site
GET /policy/api/v1/cluster/backups/overview
GET /api/v1/cluster/backups/overview
System Administration > Lifecycle Management > Backup Restore Management > Backup
Get backup status
GET /policy/api/v1/cluster/backups/status
GET /api/v1/cluster/backups/status
System Administration > Lifecycle Management > Backup Restore Management > Restore
Initiate a restore operation
POST /policy/api/v1/cluster/restore?action=start
POST /api/v1/cluster/restore?action=start
System Administration > Lifecycle Management > Backup Restore Management > Restore
Advance any suspended restore operation
POST /policy/api/v1/cluster/restore?action=advance
POST /api/v1/cluster/restore?action=advance
System Administration > Lifecycle Management > Backup Restore Management > Restore
Suspend any running restore operation
POST /policy/api/v1/cluster/restore?action=suspend
POST /api/v1/cluster/restore?action=suspend
System Administration > Lifecycle Management > Backup Restore Management > Restore
Cancel any running restore operation
POST /policy/api/v1/cluster/restore?action=cancel
POST /api/v1/cluster/restore?action=cancel
System Administration > Lifecycle Management > Backup Restore Management > Restore
Retry any failed restore operation
POST /policy/api/v1/cluster/restore?action=retry
POST /api/v1/cluster/restore?action=retry
System Administration > Lifecycle Management > Backup Restore Management > Restore
List timestamps of all available Cluster Backups.
GET /policy/api/v1/cluster/restore/backuptimestamps
GET /api/v1/cluster/restore/backuptimestamps
System Administration > Lifecycle Management > Backup Restore Management > Restore
Deprecated. Get Restore configuration
GET /policy/api/v1/cluster/restore/config (Deprecated)
GET /api/v1/cluster/restore/config (Deprecated)
System Administration > Lifecycle Management > Backup Restore Management > Restore
Deprecated. Configure Restore SFTP server credentials
PUT /policy/api/v1/cluster/restore/config (Deprecated)
PUT /api/v1/cluster/restore/config (Deprecated)
System Administration > Lifecycle Management > Backup Restore Management > Restore
List resources for a given instruction, to be shown to/executed by users.
GET /policy/api/v1/cluster/restore/instruction-resources
GET /api/v1/cluster/restore/instruction-resources
System Administration > Lifecycle Management > Backup Restore Management > Restore
Query Restore Request Status
GET /api/v1/cluster/restore/status
System Administration > Lifecycle Management > Migration
Perform steps required to finalize the infra.
POST /api/v1/migration?action=finalize_infra
System Administration > Lifecycle Management > Migration > Feedback
NSX-V feedback details
GET /api/v1/migration/feedback-requests
System Administration > Lifecycle Management > Migration > Feedback
Accept default action for feedbacks
POST /api/v1/migration/feedback-response?action=accept-recommended
System Administration > Lifecycle Management > Migration > Feedback
Migration feedback response
PUT /api/v1/migration/feedback-response
System Administration > Lifecycle Management > Migration > Feedback
Feedback request summary
GET /api/v1/migration/feedback-summary
System Administration > Lifecycle Management > Migration > Feedback
NSX-V feedback details
GET /api/v1/migration/grouped-feedback-requests
System Administration > Lifecycle Management > Migration > Group
Return information of all migration unit groups
GET /api/v1/migration/migration-unit-groups
System Administration > Lifecycle Management > Migration > Group
Create a group
POST /api/v1/migration/migration-unit-groups
System Administration > Lifecycle Management > Migration > Group
Get migration status for migration unit groups
GET /api/v1/migration/migration-unit-groups-status
System Administration > Lifecycle Management > Migration > Group
Delete the migration unit group
DELETE /api/v1/migration/migration-unit-groups/<group-id>
System Administration > Lifecycle Management > Migration > Group
Return migration unit group information
GET /api/v1/migration/migration-unit-groups/<group-id>
System Administration > Lifecycle Management > Migration > Group
Add migration units to specified migration unit group
POST /api/v1/migration/migration-unit-groups/<group-id>?action=add_migration_units
System Administration > Lifecycle Management > Migration > Group
Reorder migration unit group
POST /api/v1/migration/migration-unit-groups/<group-id>?action=reorder
System Administration > Lifecycle Management > Migration > Group
Update the migration unit group
PUT /api/v1/migration/migration-unit-groups/<group-id>
System Administration > Lifecycle Management > Migration > Group
Reorder an migration unit within the migration unit group
POST /api/v1/migration/migration-unit-groups/<group-id>/migration-unit/<migration-unit-id>?action=reorder
System Administration > Lifecycle Management > Migration > Group
Get migration status for group
GET /api/v1/migration/migration-unit-groups/<group-id>/status
System Administration > Lifecycle Management > Migration > Group
Return aggregate information of all migration unit groups
GET /api/v1/migration/migration-unit-groups/aggregate-info
System Administration > Lifecycle Management > Migration > Migration Units
Get migration units
GET /api/v1/migration/migration-units
System Administration > Lifecycle Management > Migration > Migration Units
Get migration units stats
GET /api/v1/migration/migration-units-stats
System Administration > Lifecycle Management > Migration > Migration Units
Get a specific migration unit
GET /api/v1/migration/migration-units/<migration-unit-id>
System Administration > Lifecycle Management > Migration > Migration Units
Get migration units aggregate-info
GET /api/v1/migration/migration-units/aggregate-info
System Administration > Lifecycle Management > Migration > NVDS
Set the migrate status key of ExtraConfigProfile of all Transport Nodes to IGNORE
PUT /policy/api/v1/infra/nvds-urt?action=ignore_migrate_status
System Administration > Lifecycle Management > Migration > NVDS
Clean up all nvds upgrade related configurations
PUT /policy/api/v1/infra/nvds-urt?action=cleanup
System Administration > Lifecycle Management > Migration > NVDS
Retrieve latest precheck ID of the N-VDS to VDS migration
GET /policy/api/v1/infra/nvds-urt/precheck
System Administration > Lifecycle Management > Migration > NVDS
Start precheck for N-VDS to VDS migration
PUT /policy/api/v1/infra/nvds-urt/precheck
System Administration > Lifecycle Management > Migration > NVDS
Start precheck for N-VDS to VDS migration by clusters
PUT /policy/api/v1/infra/nvds-urt/precheck-by-clusters
System Administration > Lifecycle Management > Migration > NVDS
Get summary of N-VDS to VDS migration
GET /policy/api/v1/infra/nvds-urt/status-summary/<precheck-id>
System Administration > Lifecycle Management > Migration > NVDS
Set VDS configuration and create it in vCenter
PUT /policy/api/v1/infra/nvds-urt/topology?action=apply
System Administration > Lifecycle Management > Migration > NVDS
Recommmended topology
GET /policy/api/v1/infra/nvds-urt/topology/<precheck-id>
System Administration > Lifecycle Management > Migration > Nodes
Get list of nodes across all types
GET /api/v1/migration/nodes
System Administration > Lifecycle Management > Migration > Nodes
Get summary of nodes
GET /api/v1/migration/nodes-summary
System Administration > Lifecycle Management > Migration > Plan
List migrated resources
GET /api/v1/migration/migrated-resources
System Administration > Lifecycle Management > Migration > Plan
This api is used to get mp policy promotion history. The history contains details about date and time of different promotion operations like INITIATED, CANCELLED, SUCCESS.
GET /api/v1/migration/mp-policy-promotion/history
System Administration > Lifecycle Management > Migration > Plan
This api is used to get mp policy promotion state.
GET /api/v1/migration/mp-policy-promotion/state
System Administration > Lifecycle Management > Migration > Plan
This will trigger the migration from mp to policy.
POST /api/v1/migration/mp-to-policy
System Administration > Lifecycle Management > Migration > Plan
Cancel migration
POST /api/v1/migration/mp-to-policy/cancel
System Administration > Lifecycle Management > Migration > Plan
To get MP2Policy promotion feedback.
GET /api/v1/migration/mp-to-policy/feedback
System Administration > Lifecycle Management > Migration > Plan
To get MP2Policy promotion stats.
GET /api/v1/migration/mp-to-policy/stats
System Administration > Lifecycle Management > Migration > Plan
Mark completion of a migration cycle
POST /api/v1/migration/plan?action=finish
System Administration > Lifecycle Management > Migration > Plan
Start migration
POST /api/v1/migration/plan?action=start
System Administration > Lifecycle Management > Migration > Plan
Pause migration
POST /api/v1/migration/plan?action=pause
System Administration > Lifecycle Management > Migration > Plan
Update migration-state of federation site
POST /api/v1/migration/plan?action=update_site_migration_state
System Administration > Lifecycle Management > Migration > Plan
Abort migration
POST /api/v1/migration/plan?action=abort
System Administration > Lifecycle Management > Migration > Plan
Continue migration
POST /api/v1/migration/plan?action=continue
System Administration > Lifecycle Management > Migration > Plan
Reset migration plan to default plan
POST /api/v1/migration/plan?action=reset
System Administration > Lifecycle Management > Migration > Plan
Rollbabck migration
POST /api/v1/migration/plan?action=rollback
System Administration > Lifecycle Management > Migration > Plan
Get migration plan settings for the component
GET /api/v1/migration/plan/<component_type>/settings
System Administration > Lifecycle Management > Migration > Plan
Update migration plan settings for the component
PUT /api/v1/migration/plan/<component_type>/settings
System Administration > Lifecycle Management > Migration > Plan
Get migration-state of all the federation sites.
GET /api/v1/migration/plan/site-migration-state
System Administration > Lifecycle Management > Migration > Setup
NSX-V setup details
GET /api/v1/migration/setup
System Administration > Lifecycle Management > Migration > Setup
Add NSX-V to NSX-T site mapping
PUT /api/v1/migration/setup?action=addV2tSiteMapping
System Administration > Lifecycle Management > Migration > Setup
Add ALB endpoint details for non cross VC migration modes.
PUT /api/v1/migration/setup?action=addAlbInfo
System Administration > Lifecycle Management > Migration > Setup
Set the NSX-V ESG to NSX-T Router mapping option.
PUT /api/v1/migration/setup?action=setEsgToRouterMappingOption
System Administration > Lifecycle Management > Migration > Setup
NSX-V setup details
PUT /api/v1/migration/setup
System Administration > Lifecycle Management > Migration > Stats
Delete the migration data file
DELETE /api/v1/migration/data
System Administration > Lifecycle Management > Migration > Stats
Get Migration Data Info.
GET /api/v1/migration/data
System Administration > Lifecycle Management > Migration > Stats
Download migration data
GET /api/v1/migration/data/download
System Administration > Lifecycle Management > Migration > Stats
Upload migration data
POST /api/v1/migration/data/upload
System Administration > Lifecycle Management > Migration > Stats
Get migration stats for logical constructs phase
GET /api/v1/migration/logical-constructs/stats
System Administration > Lifecycle Management > Migration > Status
Get migration status summary
GET /api/v1/migration/status-summary
System Administration > Lifecycle Management > Migration > Status
Get migration summary
GET /api/v1/migration/summary
System Administration > Lifecycle Management > Migration > User Inputs
Get the list of discovered switches (DVS, VSS)
GET /api/v1/migration/discovered-switches
System Administration > Lifecycle Management > Migration > User Inputs
Get the list of migrated switches (DVS, VSS)
GET /api/v1/migration/migrated-switches
System Administration > Lifecycle Management > Migration > User Inputs
Get the switch set as current scope for migration
GET /api/v1/migration/switch
System Administration > Lifecycle Management > Migration > User Inputs
Set the switch as current scope for migration
PUT /api/v1/migration/switch
System Administration > Lifecycle Management > Migration > Vmgroup
Perform steps required before migrating a VM group.
POST /api/v1/migration/vmgroup?action=pre_migrate
System Administration > Lifecycle Management > Migration > Vmgroup
Perform steps required after migrating a VM group.
POST /api/v1/migration/vmgroup?action=post_migrate
System Administration > Lifecycle Management > Upgrade > Bundles
Upgrade the upgrade coordinator.
POST /api/v1/upgrade?action=upgrade_uc
System Administration > Lifecycle Management > Upgrade > Bundles
Upload upgrade bundle
POST /api/v1/upgrade/bundle?action=upload (Deprecated)
System Administration > Lifecycle Management > Upgrade > Bundles
Upload upgrade bundle
POST /api/v1/upgrade/bundles?action=upload
System Administration > Lifecycle Management > Upgrade > Bundles
Fetch upgrade bundle from given url
POST /api/v1/upgrade/bundles
System Administration > Lifecycle Management > Upgrade > Bundles
Get uploaded upgrade bundle information
GET /api/v1/upgrade/bundles/<bundle-id>
System Administration > Lifecycle Management > Upgrade > Bundles
Cancel upgrade bundle upload
POST /api/v1/upgrade/bundles/<bundle-id>?action=cancel_upload
System Administration > Lifecycle Management > Upgrade > Bundles
Get uploaded upgrade bundle upload status
GET /api/v1/upgrade/bundles/<bundle-id>/upload-status
System Administration > Lifecycle Management > Upgrade > Eula
Accept end user license agreement
POST /api/v1/upgrade/eula/accept
System Administration > Lifecycle Management > Upgrade > Eula
Return the acceptance status of end user license agreement
GET /api/v1/upgrade/eula/acceptance
System Administration > Lifecycle Management > Upgrade > Eula
Return the content of end user license agreement
GET /api/v1/upgrade/eula/content
System Administration > Lifecycle Management > Upgrade > Group
Return information of all upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups
System Administration > Lifecycle Management > Upgrade > Group
Create a group
POST /api/v1/upgrade/upgrade-unit-groups
System Administration > Lifecycle Management > Upgrade > Group
Get upgrade status for upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups-status
System Administration > Lifecycle Management > Upgrade > Group
Delete the upgrade unit group
DELETE /api/v1/upgrade/upgrade-unit-groups/<group-id>
System Administration > Lifecycle Management > Upgrade > Group
Return upgrade unit group information
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>
System Administration > Lifecycle Management > Upgrade > Group
Add upgrade units to specified upgrade unit group
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=add_upgrade_units
System Administration > Lifecycle Management > Upgrade > Group
Reorder upgrade unit group
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>?action=reorder
System Administration > Lifecycle Management > Upgrade > Group
Update the upgrade unit group
PUT /api/v1/upgrade/upgrade-unit-groups/<group-id>
System Administration > Lifecycle Management > Upgrade > Group
Get upgrade status for group
GET /api/v1/upgrade/upgrade-unit-groups/<group-id>/status
System Administration > Lifecycle Management > Upgrade > Group
Reorder an upgrade unit within the upgrade unit group
POST /api/v1/upgrade/upgrade-unit-groups/<group-id>/upgrade-unit/<upgrade-unit-id>?action=reorder
System Administration > Lifecycle Management > Upgrade > Group
Return aggregate information of all upgrade unit groups
GET /api/v1/upgrade/upgrade-unit-groups/aggregate-info
System Administration > Lifecycle Management > Upgrade > History
Get upgrade history
GET /api/v1/upgrade/history
System Administration > Lifecycle Management > Upgrade > Nodes
Get upgrade task status
GET /api/v1/cluster/<cluster-node-id>/node/upgrade (Deprecated)
GET /api/v1/node/upgrade (Deprecated)
System Administration > Lifecycle Management > Upgrade > Nodes
Execute upgrade task
POST /api/v1/node/upgrade/performtask
POST /api/v1/cluster/<cluster-node-id>/node/upgrade/performtask
System Administration > Lifecycle Management > Upgrade > Nodes
Get upgrade progress status
GET /api/v1/node/upgrade/progress-status
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/progress-status
System Administration > Lifecycle Management > Upgrade > Nodes
Get upgrade status summary
GET /api/v1/cluster/<cluster-node-id>/node/upgrade/status-summary
GET /api/v1/node/upgrade/status-summary
System Administration > Lifecycle Management > Upgrade > Nodes
Get list of nodes across all types
GET /api/v1/upgrade/nodes
System Administration > Lifecycle Management > Upgrade > Nodes
Get summary of nodes
GET /api/v1/upgrade/nodes-summary
System Administration > Lifecycle Management > Upgrade > Nodes
Get the version whitelist
GET /policy/api/v1/upgrade/version-whitelist
GET /api/v1/upgrade/version-whitelist
System Administration > Lifecycle Management > Upgrade > Nodes
Get the version whitelist for the specified component
GET /policy/api/v1/upgrade/version-whitelist/<component_type>
GET /api/v1/upgrade/version-whitelist/<component_type>
System Administration > Lifecycle Management > Upgrade > Nodes
Update the version whitelist for the specified component type
PUT /policy/api/v1/upgrade/version-whitelist/<component_type>
PUT /api/v1/upgrade/version-whitelist/<component_type>
System Administration > Lifecycle Management > Upgrade > Plan
Abort pre-upgrade checks
POST /api/v1/upgrade?action=abort_pre_upgrade_checks
System Administration > Lifecycle Management > Upgrade > Plan
Execute pre-upgrade checks
POST /api/v1/upgrade?action=execute_pre_upgrade_checks
System Administration > Lifecycle Management > Upgrade > Plan
Execute post-upgrade checks
POST /api/v1/upgrade/<component-type>?action=execute_post_upgrade_checks
System Administration > Lifecycle Management > Upgrade > Plan
Upgrade selected units
POST /api/v1/upgrade/plan?action=upgrade_selected_units
System Administration > Lifecycle Management > Upgrade > Plan
Stage the upgrade bits
POST /api/v1/upgrade/plan?action=stage-upgrade
System Administration > Lifecycle Management > Upgrade > Plan
Start upgrade
POST /api/v1/upgrade/plan?action=start
System Administration > Lifecycle Management > Upgrade > Plan
Pause upgrade
POST /api/v1/upgrade/plan?action=pause
System Administration > Lifecycle Management > Upgrade > Plan
Reset upgrade plan to default plan
POST /api/v1/upgrade/plan?action=reset
System Administration > Lifecycle Management > Upgrade > Plan
Continue upgrade
POST /api/v1/upgrade/plan?action=continue
System Administration > Lifecycle Management > Upgrade > Plan
Get upgrade plan settings for the component
GET /api/v1/upgrade/plan/<component_type>/settings
System Administration > Lifecycle Management > Upgrade > Plan
Update upgrade plan settings for the component
PUT /api/v1/upgrade/plan/<component_type>/settings
System Administration > Lifecycle Management > Upgrade > Plan
Returns pre-upgrade checks in csv format
GET /api/v1/upgrade/pre-upgrade-checks?format=csv
System Administration > Lifecycle Management > Upgrade > Plan
Get Pre-upgrade Check Failures
GET /api/v1/upgrade/pre-upgrade-checks/failures
System Administration > Lifecycle Management > Upgrade > Plan
Returns information about upgrade checks
GET /api/v1/upgrade/upgrade-checks-info
System Administration > Lifecycle Management > Upgrade > Status
Get functional state of the upgrade coordinator
GET /api/v1/upgrade/functional-state
System Administration > Lifecycle Management > Upgrade > Status
Get upgrade status summary
GET /api/v1/upgrade/status-summary
System Administration > Lifecycle Management > Upgrade > Status
Get upgrade summary
GET /api/v1/upgrade/summary
System Administration > Lifecycle Management > Upgrade > Status
Get upgrade-coordinator upgrade status
GET /api/v1/upgrade/uc-upgrade-status
System Administration > Lifecycle Management > Upgrade > Upgrade Coordinator
Triggers Repository driven Uc Upgrade
POST /api/v1/node/upgrade/uc
POST /api/v1/cluster/<cluster-node-id>/node/upgrade/uc
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get upgrade units
GET /api/v1/upgrade/upgrade-units
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get upgrade units stats
GET /api/v1/upgrade/upgrade-units-stats
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get a specific upgrade unit
GET /api/v1/upgrade/upgrade-units/<upgrade-unit-id>
System Administration > Lifecycle Management > Upgrade > Upgrade Units
Get upgrade units aggregate-info
GET /api/v1/upgrade/upgrade-units/aggregate-info
System Administration > Monitoring > Alarms And Events
Get the list of all Alarms currently known to the system.
GET /api/v1/alarms
System Administration > Monitoring > Alarms And Events
Bulk update the status of zero or more Alarms.
POST /api/v1/alarms?action=set_status
System Administration > Monitoring > Alarms And Events
Get Alarm identified by alarm-id.
GET /api/v1/alarms/<alarm-id>
System Administration > Monitoring > Alarms And Events
Update staus of alarm identified by alarm-id.
POST /api/v1/alarms/<alarm-id>?action=set_status
System Administration > Monitoring > Alarms And Events
Get the list of all Events defined in NSX.
GET /api/v1/events
System Administration > Monitoring > Alarms And Events
Get Events identified by event-id.
GET /api/v1/events/<event-id>
System Administration > Monitoring > Alarms And Events
Reset all user configurable values to factory defaults.
POST /api/v1/events/<event-id>?action=set_default
System Administration > Monitoring > Alarms And Events
Update event associated with event-id.
PUT /api/v1/events/<event-id>
System Administration > Monitoring > Dashboards > Capacity Dashboard
Returns warning threshold(s) set for NSX Objects.
GET /api/v1/capacity/threshold
System Administration > Monitoring > Dashboards > Capacity Dashboard
Updates the warning threshold(s) for NSX Objects.
PUT /api/v1/capacity/threshold
System Administration > Monitoring > Dashboards > Capacity Dashboard
Returns capacity usage data for NSX objects
GET /api/v1/capacity/usage
System Administration > Monitoring > Dashboards > UI Views
Returns the Views based on query criteria defined in ViewQueryParameters.
GET /api/v1/ui-views
System Administration > Monitoring > Dashboards > UI Views
Creates a new View.
POST /api/v1/ui-views
System Administration > Monitoring > Dashboards > UI Views
Delete View
DELETE /api/v1/ui-views/<view-id>
System Administration > Monitoring > Dashboards > UI Views
Returns View Information
GET /api/v1/ui-views/<view-id>
System Administration > Monitoring > Dashboards > UI Views
Update View
PUT /api/v1/ui-views/<view-id>
System Administration > Monitoring > Dashboards > Widget Configuration
Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.
GET /api/v1/ui-views/<view-id>/widgetconfigurations
System Administration > Monitoring > Dashboards > Widget Configuration
Creates a new Widget Configuration.
POST /api/v1/ui-views/<view-id>/widgetconfigurations
System Administration > Monitoring > Dashboards > Widget Configuration
Delete Widget Configuration
DELETE /api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
System Administration > Monitoring > Dashboards > Widget Configuration
Returns Widget Configuration Information
GET /api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
System Administration > Monitoring > Dashboards > Widget Configuration
Update Widget Configuration
PUT /api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
System Administration > Monitoring > Error Resolver
Fetches a list of metadata for all the registered error resolvers
GET /policy/api/v1/error-resolver
GET /api/v1/error-resolver
System Administration > Monitoring > Error Resolver
Resolves the error
POST /policy/api/v1/error-resolver?action=resolve_error
POST /api/v1/error-resolver?action=resolve_error
System Administration > Monitoring > Error Resolver
Fetches metadata about the given error_id
GET /policy/api/v1/error-resolver/<error_id>
GET /api/v1/error-resolver/<error_id>
System Administration > Monitoring > Health Checks
Get automatic health check toggle
GET /api/v1/automatic-health-check-toggle
System Administration > Monitoring > Health Checks
Update automatic health check toggle
PUT /api/v1/automatic-health-check-toggle
System Administration > Monitoring > Health Checks
List automatic health checks
GET /api/v1/automatic-health-checks
System Administration > Monitoring > Health Checks
Get an automatic health check
GET /api/v1/automatic-health-checks/transport-zones/<transport-zone-id>
System Administration > Monitoring > Health Performance Monitoring
List all health performance monitoring feature stacks
GET /api/v1/hpm/features
System Administration > Monitoring > Health Performance Monitoring
Read health performance monitoring configuration for feature stack
GET /api/v1/hpm/features/<feature-stack-name>
System Administration > Monitoring > Health Performance Monitoring
Reset the data collection frequency configuration setting to the default values
POST /api/v1/hpm/features/<feature-stack-name>?action=reset_collection_frequency
System Administration > Monitoring > Health Performance Monitoring
Update health performance monitoring configuration for feature stack
PUT /api/v1/hpm/features/<feature-stack-name>
System Administration > Monitoring > Health Performance Monitoring
Read global health performance monitoring configuration
GET /api/v1/hpm/global-config
System Administration > Monitoring > Health Performance Monitoring
Set the global configuration for aggregation service related data collection
PUT /api/v1/hpm/global-config
System Administration > Monitoring > Latency Profiles
List latency profiles
GET /api/v1/latency-profiles (Deprecated)
System Administration > Monitoring > Latency Profiles
Create a new latency profile
POST /api/v1/latency-profiles (Deprecated)
System Administration > Monitoring > Latency Profiles
Delete an existing latency profile
DELETE /api/v1/latency-profiles/<latency-profile-id> (Deprecated)
System Administration > Monitoring > Latency Profiles
Get an existing latency profile configuration
GET /api/v1/latency-profiles/<latency-profile-id> (Deprecated)
System Administration > Monitoring > Latency Profiles
Update an existing latency profile
PUT /api/v1/latency-profiles/<latency-profile-id> (Deprecated)
System Administration > Monitoring > Logs > Audit Logs
Collect audit logs from registered manager nodes
POST /api/v1/administration/audit-logs
System Administration > Monitoring > Logs > Core Dumps
List system core dumps
GET /api/v1/node/core-dumps
GET /api/v1/transport-nodes/<transport-node-id>/node/core-dumps
GET /api/v1/cluster/<cluster-node-id>/node/core-dumps
System Administration > Monitoring > Logs > Core Dumps
Copy system generated core dump file to a remote file store
POST /api/v1/cluster/<cluster-node-id>/node/core-dumps/<file-name>?action=copy_to_remote_file
POST /api/v1/node/core-dumps/<file-name>?action=copy_to_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/core-dumps/<file-name>?action=copy_to_remote_file
System Administration > Monitoring > Notifications
Returns a list of registered notification watchers.
GET /api/v1/notification-watchers
System Administration > Monitoring > Notifications
Add a new notification watcher.
POST /api/v1/notification-watchers
System Administration > Monitoring > Notifications
Delete an existing Notification-Watcher.
DELETE /api/v1/notification-watchers/<watcher-id>
System Administration > Monitoring > Notifications
Returns notification watcher by watcher id.
GET /api/v1/notification-watchers/<watcher-id>
System Administration > Monitoring > Notifications
Update notification watcher.
PUT /api/v1/notification-watchers/<watcher-id>
System Administration > Monitoring > Notifications
Get notifications for the specified watcher ID.
GET /api/v1/notification-watchers/<watcher-id>/notifications
System Administration > Monitoring > Notifications
Add uri filters for the specified watcher ID.
POST /api/v1/notification-watchers/<watcher-id>/notifications?action=add_uri_filters
System Administration > Monitoring > Notifications
Delete uri filters for the specified watcher ID.
POST /api/v1/notification-watchers/<watcher-id>/notifications?action=delete_uri_filters
System Administration > Monitoring > Notifications
Update notifications for the specified watcher ID.
PUT /api/v1/notification-watchers/<watcher-id>/notifications
System Administration > Monitoring > System Health > Appliance > Process
Show the details of process status in given appliance
GET /api/v1/systemhealth/appliances/<appliance-id>/latency/status
System Administration > Monitoring > System Health > Appliance > Process
Show the details of process status in given appliance
GET /api/v1/systemhealth/appliances/<appliance-id>/process/status
System Administration > Monitoring > System Health > Appliance > Process
Show the details of latency status for all appliances
GET /api/v1/systemhealth/appliances/latency/status
System Administration > Monitoring > System Health > Appliance > Process
Show the details of process status in all appliances.
GET /api/v1/systemhealth/appliances/process/status
System Administration > Monitoring > System Health > Container
Create container cluster status list
DELETE /api/v1/systemhealth/container-cluster/<cluster-id>/ncp/status
System Administration > Monitoring > System Health > Container
Get the container cluster status by given id
GET /api/v1/systemhealth/container-cluster/<cluster-id>/ncp/status
System Administration > Monitoring > System Health > Container
Get all the container cluster status
GET /api/v1/systemhealth/container-cluster/ncp/status
System Administration > Monitoring > System Health > Container
Create container cluster status list
POST /api/v1/systemhealth/container-cluster/ncp/status
System Administration > Monitoring > System Health > Container
Get the containter status on given node
GET /api/v1/systemhealth/transport-nodes/<node-id>/container/agent/status
System Administration > Monitoring > System Health > Container
Get the containter hyperbus status on given node
GET /api/v1/systemhealth/transport-nodes/<node-id>/container/hyperbus/status
System Administration > Monitoring > System Health > Container > Antrea
Read Antrea cluster heartbeat config list
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes-heartbeat-config
System Administration > Monitoring > System Health > Container > Antrea
Read Antrea cluster status list
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes-status
System Administration > Monitoring > System Health > Container > Antrea
Read Antrea heartbeat configuration
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/heartbeat-config
System Administration > Monitoring > System Health > Container > Antrea
Patch the Antrea heartbeat configuration
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/heartbeat-config
System Administration > Monitoring > System Health > Container > Antrea
Update the Antrea heartbeat configuration
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/heartbeat-config
System Administration > Monitoring > System Health > Container > Antrea
Read Antrea cluster status
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/status
System Administration > Monitoring > System Health > Plugins
Show all the system health plugin
GET /api/v1/systemhealth/plugins (Deprecated)
System Administration > Monitoring > System Health > Plugins
Create a system health plugin
POST /api/v1/systemhealth/plugins (Deprecated)
System Administration > Monitoring > System Health > Plugins
Delete an existing system health plugin
DELETE /api/v1/systemhealth/plugins/<plugin-id> (Deprecated)
System Administration > Monitoring > System Health > Plugins
Show the details of a system health plugin
GET /api/v1/systemhealth/plugins/<plugin-id> (Deprecated)
System Administration > Monitoring > System Health > Plugins
Upload a plugin File to MP
POST /api/v1/systemhealth/plugins/<plugin-id>/files/<file-name>/data
System Administration > Monitoring > System Health > Plugins
Show the installed system health plugin list
GET /api/v1/systemhealth/plugins/status/<node-id>
System Administration > Monitoring > System Health > Profiles
List all system health profiles
GET /api/v1/systemhealth/profiles (Deprecated)
System Administration > Monitoring > System Health > Profiles
Create a system health profile
POST /api/v1/systemhealth/profiles (Deprecated)
System Administration > Monitoring > System Health > Profiles
Delete an existing system health profile
DELETE /api/v1/systemhealth/profiles/<profile-id> (Deprecated)
System Administration > Monitoring > System Health > Profiles
Show the details of a system health profile
GET /api/v1/systemhealth/profiles/<profile-id> (Deprecated)
System Administration > Monitoring > System Health > Profiles
Update a system health profile
PUT /api/v1/systemhealth/profiles/<profile-id> (Deprecated)
System Administration > Settings > Certificates > CRL
Return the list of CrlDistributionPoints
GET /api/v1/trust-management/crl-distribution-points
System Administration > Settings > Certificates > CRL
Create a Crl Distribution Point
POST /api/v1/trust-management/crl-distribution-points
System Administration > Settings > Certificates > CRL
Delete a CrlDistributionPoint
DELETE /api/v1/trust-management/crl-distribution-points/<crl-distribution-point-id>
System Administration > Settings > Certificates > CRL
Return the CrlDistributionPoint with <crl-distribution-point-id>
GET /api/v1/trust-management/crl-distribution-points/<crl-distribution-point-id>
System Administration > Settings > Certificates > CRL
Update CrlDistributionPoint with <crl-distribution-point-id> This allows updating the ManagedResource fields.
PUT /api/v1/trust-management/crl-distribution-points/<crl-distribution-point-id>
System Administration > Settings > Certificates > CRL
Return the status of the CrlDistributionPoint
GET /api/v1/trust-management/crl-distribution-points/<crl-distribution-point-id>/status
System Administration > Settings > Certificates > CRL
Return stored CRL in PEM format
POST /api/v1/trust-management/crl-distribution-points/pem-file
System Administration > Settings > Certificates > CSR
Return the Properties of a Trust Manager
GET /api/v1/trust-management
System Administration > Settings > Certificates > CSR
Return All Added CRLs
GET /api/v1/trust-management/crls
System Administration > Settings > Certificates > CSR
Add a New Certificate Revocation List
POST /api/v1/trust-management/crls?action=import
System Administration > Settings > Certificates > CSR
Delete a CRL
DELETE /api/v1/trust-management/crls/<crl-id>
System Administration > Settings > Certificates > CSR
Show CRL Data for the Given CRL ID
GET /api/v1/trust-management/crls/<crl-id>
System Administration > Settings > Certificates > CSR
Update CRL for the Given CRL ID
PUT /api/v1/trust-management/crls/<crl-id>
System Administration > Settings > Certificates > CSR
Return All the Generated CSRs
GET /api/v1/trust-management/csrs
System Administration > Settings > Certificates > CSR
Generate a New Certificate Signing Request
POST /api/v1/trust-management/csrs
System Administration > Settings > Certificates > CSR
Generate a New Self-Signed Certificate
POST /api/v1/trust-management/csrs?action=self_sign
System Administration > Settings > Certificates > CSR
Generate a New Certificate Signing Request with Extensions
POST /api/v1/trust-management/csrs-extended (Experimental)
System Administration > Settings > Certificates > CSR
Delete a CSR
DELETE /api/v1/trust-management/csrs/<csr-id>
System Administration > Settings > Certificates > CSR
Show CSR Data for the Given CSR ID
GET /api/v1/trust-management/csrs/<csr-id>
System Administration > Settings > Certificates > CSR
Upload the Certificate PEM File Signed by the CA Associated with a CSR
POST /api/v1/trust-management/csrs/<csr-id>?action=upload
System Administration > Settings > Certificates > CSR
Import a Certificate Associated with an Approved CSR
POST /api/v1/trust-management/csrs/<csr-id>?action=import
System Administration > Settings > Certificates > CSR
Self-Sign the CSR
POST /api/v1/trust-management/csrs/<csr-id>?action=self_sign
System Administration > Settings > Certificates > CSR
Get CSR PEM File for the Given CSR ID
GET /api/v1/trust-management/csrs/<csr-id>/pem-file
System Administration > Settings > Certificates > Certificate
Get the certificate profile for the given service type
GET /api/v1/trust-management/certificate-profile/<service-type>
System Administration > Settings > Certificates > Certificate
Return the list of certificate profiles.
GET /api/v1/trust-management/certificate-profiles
System Administration > Settings > Certificates > Certificate
Return All the User-Facing Components' Certificates
GET /api/v1/trust-management/certificates
System Administration > Settings > Certificates > Certificate
Add a New Certificate
POST /api/v1/trust-management/certificates?action=import
System Administration > Settings > Certificates > Certificate
Set a certificate as the Appliance Proxy certificate to be used in inter-site communication
POST /api/v1/trust-management/certificates?action=set_appliance_proxy_certificate_for_inter_site_communication
System Administration > Settings > Certificates > Certificate
Delete Certificate for the Given Certificate ID
DELETE /api/v1/trust-management/certificates/<cert-id>
System Administration > Settings > Certificates > Certificate
Show Certificate Data for the Given Certificate ID
GET /api/v1/trust-management/certificates/<cert-id>
System Administration > Settings > Customer Experience Improvement > Telemetry
Returns telemetry agreement information
GET /api/v1/telemetry/agreement
System Administration > Settings > Customer Experience Improvement > Telemetry
Set telemetry agreement information
PUT /api/v1/telemetry/agreement
System Administration > Settings > Customer Experience Improvement > Telemetry
Returns the telemetry configuration
GET /api/v1/telemetry/config
System Administration > Settings > Customer Experience Improvement > Telemetry
Creates or updates the telemetry configuration
PUT /api/v1/telemetry/config
System Administration > Settings > Licenses
Accept end user license agreement
POST /policy/api/v1/eula/accept
POST /api/v1/eula/accept
System Administration > Settings > Licenses
Return the acceptance status of end user license agreement
GET /policy/api/v1/eula/acceptance
GET /api/v1/eula/acceptance
System Administration > Settings > Licenses
Return the content of end user license agreement
GET /policy/api/v1/eula/content
GET /api/v1/eula/content
System Administration > Settings > Licenses
Deprecated. Return the Enterprise License
GET /api/v1/license (Deprecated)
System Administration > Settings > Licenses
Deprecated. Assign an Updated Enterprise License Key
PUT /api/v1/license (Deprecated)
System Administration > Settings > Licenses
Get all licenses
GET /api/v1/licenses
System Administration > Settings > Licenses
Remove a license
POST /api/v1/licenses?action=delete
System Administration > Settings > Licenses
Add a new license key
POST /api/v1/licenses
System Administration > Settings > Licenses
Deprecated. Remove a license identified by the license-key
DELETE /api/v1/licenses/<license-key> (Deprecated)
System Administration > Settings > Licenses
Deprecated. Get license properties for license identified by the license-key
GET /api/v1/licenses/<license-key> (Deprecated)
System Administration > Settings > Licenses
Get usage report of all registered modules
GET /api/v1/licenses/licenses-usage
System Administration > Settings > Licenses
Get usage report of all registred modules in CSV format
GET /api/v1/licenses/licenses-usage?format=csv
System Administration > Settings > Proxy Settings
Returns the proxy configuration
GET /api/v1/proxy/config
System Administration > Settings > Proxy Settings
Creates or updates the proxy configuration
PUT /api/v1/proxy/config
System Administration > Settings > Support Bundle
Collect support bundles from registered cluster and fabric nodes
POST /api/v1/administration/support-bundles?action=collect
System Administration > Settings > Support Bundle
Delete existing support bundles waiting to be downloaded
POST /api/v1/administration/support-bundles?action=delete_async_response
System Administration > Settings > Support Bundle
Get list of supported content filters
GET /api/v1/administration/support-bundles/dynamic-content-filters
System Administration > Settings > User Management > Access Token
Create registration access token
POST /policy/api/v1/aaa/registration-token
POST /api/v1/aaa/registration-token
System Administration > Settings > User Management > Access Token
Delete registration access token
DELETE /policy/api/v1/aaa/registration-token/<token>
DELETE /api/v1/aaa/registration-token/<token>
System Administration > Settings > User Management > Access Token
Get registration access token
GET /policy/api/v1/aaa/registration-token/<token>
GET /api/v1/aaa/registration-token/<token>
System Administration > Settings > User Management > Authorization > Object Permissions
Get effective object permissions to object specified by path for current user.
GET /policy/api/v1/aaa/effective-permissions (Experimental)
System Administration > Settings > User Management > Authorization > Object Permissions
Delete object-permissions entries
DELETE /policy/api/v1/aaa/object-permissions (Experimental)
System Administration > Settings > User Management > Authorization > Object Permissions
Get list of Object-level RBAC entries.
GET /policy/api/v1/aaa/object-permissions (Experimental)
System Administration > Settings > User Management > Authorization > Object Permissions
Create/update object permission mappings
PATCH /policy/api/v1/aaa/object-permissions (Experimental)
System Administration > Settings > User Management > LDAP Identity Sources
List LDAP identity sources
GET /policy/api/v1/aaa/ldap-identity-sources
System Administration > Settings > User Management > LDAP Identity Sources
Test an LDAP server
POST /policy/api/v1/aaa/ldap-identity-sources?action=probe_ldap_server
System Administration > Settings > User Management > LDAP Identity Sources
Probe an LDAP identity source
POST /policy/api/v1/aaa/ldap-identity-sources?action=probe_identity_source
System Administration > Settings > User Management > LDAP Identity Sources
Fetch the server certificate of an LDAP server
POST /policy/api/v1/aaa/ldap-identity-sources?action=fetch_certificate
System Administration > Settings > User Management > LDAP Identity Sources
Delete an LDAP identity source
DELETE /policy/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>
System Administration > Settings > User Management > LDAP Identity Sources
Read a single LDAP identity source
GET /policy/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>
System Administration > Settings > User Management > LDAP Identity Sources
Test the configuration of an existing LDAP identity source
POST /policy/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>?action=probe
System Administration > Settings > User Management > LDAP Identity Sources
Update an existing LDAP identity source
PUT /policy/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>
System Administration > Settings > User Management > LDAP Identity Sources
Search the LDAP identity source
POST /policy/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>/search
System Administration > Settings > User Management > Principal Identity
Return the list of OpenID Connect end-points.
GET /api/v1/trust-management/oidc-uris
System Administration > Settings > User Management > Principal Identity
Update a OpenID Connect end-point's thumbprint
POST /api/v1/trust-management/oidc-uris?action=update_thumbprint
System Administration > Settings > User Management > Principal Identity
Add an OpenID Connect end-point.
POST /api/v1/trust-management/oidc-uris
System Administration > Settings > User Management > Principal Identity
Get an OpenID Connect end-point.
GET /api/v1/trust-management/oidc-uris/<id>
System Administration > Settings > User Management > Principal Identity
Return the list of principal identities
GET /api/v1/trust-management/principal-identities
System Administration > Settings > User Management > Principal Identity
Register a name-certificate combination.
POST /api/v1/trust-management/principal-identities (Deprecated)
System Administration > Settings > User Management > Principal Identity
Update a principal identity's certificate
POST /api/v1/trust-management/principal-identities?action=update_certificate
System Administration > Settings > User Management > Principal Identity
Delete a principal identity
DELETE /api/v1/trust-management/principal-identities/<principal-identity-id>
System Administration > Settings > User Management > Principal Identity
Get a principal identity
GET /api/v1/trust-management/principal-identities/<principal-identity-id>
System Administration > Settings > User Management > Principal Identity
Register a name-certificate combination.
POST /api/v1/trust-management/principal-identities/with-certificate
System Administration > Settings > User Management > Principal Identity
Return the list of token-based principal identities. | These don't have certificate or role information.
GET /api/v1/trust-management/token-principal-identities
System Administration > Settings > User Management > Principal Identity
Register a token-based principal identity.
POST /api/v1/trust-management/token-principal-identities
System Administration > Settings > User Management > Principal Identity
Delete a token-based principal identity
DELETE /api/v1/trust-management/token-principal-identities/<principal-identity-id>
System Administration > Settings > User Management > Principal Identity
Get a token-based principal identity
GET /api/v1/trust-management/token-principal-identities/<principal-identity-id>
System Administration > Settings > User Management > Roles
List feature permissions
GET /policy/api/v1/aaa/features-with-properties
GET /api/v1/aaa/features-with-properties
System Administration > Settings > User Management > Roles
Get all users and groups with their roles
GET /policy/api/v1/aaa/role-bindings
GET /api/v1/aaa/role-bindings
System Administration > Settings > User Management > Roles
Delete all stale role assignments
POST /policy/api/v1/aaa/role-bindings?action=delete_stale_bindings
POST /api/v1/aaa/role-bindings?action=delete_stale_bindings
System Administration > Settings > User Management > Roles
Assign roles to User or Group
POST /policy/api/v1/aaa/role-bindings
POST /api/v1/aaa/role-bindings
System Administration > Settings > User Management > Roles
Delete user/group's roles assignment
DELETE /policy/api/v1/aaa/role-bindings/<binding-id>
DELETE /api/v1/aaa/role-bindings/<binding-id>
System Administration > Settings > User Management > Roles
Get user/group's role information
GET /policy/api/v1/aaa/role-bindings/<binding-id>
GET /api/v1/aaa/role-bindings/<binding-id>
System Administration > Settings > User Management > Roles
Update User or Group's roles
PUT /policy/api/v1/aaa/role-bindings/<binding-id>
PUT /api/v1/aaa/role-bindings/<binding-id>
System Administration > Settings > User Management > Roles
Get information about all roles
GET /policy/api/v1/aaa/roles
GET /api/v1/aaa/roles
System Administration > Settings > User Management > Roles
Validate a new feature permission set
POST /policy/api/v1/aaa/roles?action=validate
POST /api/v1/aaa/roles?action=validate
System Administration > Settings > User Management > Roles
Get information about all roles with features and their permissions
GET /policy/api/v1/aaa/roles-with-feature-permissions
GET /api/v1/aaa/roles-with-feature-permissions
System Administration > Settings > User Management > Roles
Delete custom role
DELETE /policy/api/v1/aaa/roles/<role>
DELETE /api/v1/aaa/roles/<role>
System Administration > Settings > User Management > Roles
Get role information
GET /policy/api/v1/aaa/roles/<role>
GET /api/v1/aaa/roles/<role>
System Administration > Settings > User Management > Roles
Clone an already present role
POST /policy/api/v1/aaa/roles/<role>?action=clone
POST /api/v1/aaa/roles/<role>?action=clone
System Administration > Settings > User Management > Roles
Update custom role
PUT /policy/api/v1/aaa/roles/<role>
PUT /api/v1/aaa/roles/<role>
System Administration > Settings > User Management > Users
Get the name and role information of the user.
GET /policy/api/v1/aaa/user-info
GET /api/v1/aaa/user-info
System Administration > Settings > User Management > VIDM Configuration
Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered.
GET /policy/api/v1/aaa/vidm/groups
GET /api/v1/aaa/vidm/groups
System Administration > Settings > User Management > VIDM Configuration
Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user/group of interest more characters need to be entered.
POST /policy/api/v1/aaa/vidm/search
POST /api/v1/aaa/vidm/search
System Administration > Settings > User Management > VIDM Configuration
Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.
GET /policy/api/v1/aaa/vidm/users
GET /api/v1/aaa/vidm/users
System Administration > Settings > User Management > VIDM Configuration
Read AAA provider vIDM properties
GET /api/v1/node/aaa/providers/vidm
GET /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm
System Administration > Settings > User Management > VIDM Configuration
Update AAA provider vIDM properties
PUT /api/v1/node/aaa/providers/vidm
PUT /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm
System Administration > Settings > User Management > VIDM Configuration
Read AAA provider vIDM status
GET /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm/status
GET /api/v1/node/aaa/providers/vidm/status
Uncategorized APIs
Read security global configuration
GET /policy/api/v1/global-infra/security-global-config
GET /policy/api/v1/infra/security-global-config
Uncategorized APIs
Update the security global configuration
PUT /policy/api/v1/global-infra/security-global-config
PUT /policy/api/v1/infra/security-global-config
Uncategorized APIs
Set a certificate as a GM or LM Principal Identity certificate
POST /api/v1/trust-management/certificates?action=set_pi_certificate_for_federation
Uncategorized APIs
Validate a certificate
GET /api/v1/trust-management/certificates/<cert-id>?action=validate
Uncategorized APIs
Apply a certificate for a CertificateProfile
POST /api/v1/trust-management/certificates/<cert-id>?action=apply_certificate