NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List enforcementpoints for infra Paginated list of all enforcementpoints for infra.	GET /policy/api/v1/infra/deployment-zones/{deployment-zone-id}/enforcement-points (Deprecated)
Delete EnforcementPoint Delete EnforcementPoint.	DELETE /policy/api/v1/infra/deployment-zones/{deployment-zone-id}/enforcement-points/{enforcementpoint-id} (Deprecated)
Read an Enforcement Point Read an Enforcement Point.	GET /policy/api/v1/infra/deployment-zones/{deployment-zone-id}/enforcement-points/{enforcementpoint-id} (Deprecated)
Patch a new Enforcement Point under infra If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, patch it.	PATCH /policy/api/v1/infra/deployment-zones/{deployment-zone-id}/enforcement-points/{enforcementpoint-id} (Deprecated)
Create/update a new Enforcement Point under infra If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, replace it.	PUT /policy/api/v1/infra/deployment-zones/{deployment-zone-id}/enforcement-points/{enforcementpoint-id} (Deprecated)
List enforcementpoints under Site Paginated list of all enforcementpoints under Site.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points
Full sync EnforcementPoint from Site Full sync EnforcementPoint from Site	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}?action=full-sync
Get datapath troubleshoot config of edge transport nodes This API is used to fetch the control packet drop log config at enforcement Point level.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-transport-nodes/troubleshoot/datapath (Experimental)
Enable or Disable the datapath troubleshoot config on edge transport nodes This API is used to enable/disable the control packet drop log config in all edge transport nodes at the enforcement Point level.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-transport-nodes/troubleshoot/datapath (Experimental)
Delete EnforcementPoint from Site Delete EnforcementPoint from Site	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}
Read an Enforcement Point under Infra/Site 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}
Patch a new Enforcement Point under Site If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, patch it.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}
Reload an Enforcement Point under Site Reload an Enforcement Point under Site. This will read and update fabric configs from enforcement point.	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}?action=reload
Create/update a new Enforcement Point under Site If the passed Enforcement Point does not already exist, create a new Enforcement Point. If it already exists, replace it.	PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}
List Policy Edge Cluster High Availability Profiles List edge cluster high availability profiles.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles
Delete a Policy Edge Cluster High Availability Profile Delete a policy edge cluster high availability profile.	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}
Get a Policy Edge Cluster High Availability Profile Get a policy edge cluster high availability profile.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}
Patch a Policy EdgeCluster High Availability Profile Patch a policy edge cluster high availability profile.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}
Create or Update a Policy Edge Cluster High Availability Profile Create or Update a policy edge cluster high availability profile.	PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-cluster-high-availability-profiles/{edge-cluster-high-availability-profile-id}
List Edge Clusters under an Enforcement Point Paginated list of all 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
Delete the specified edge cluster. Delete the specified edge cluster.	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}
Read an Edge Cluster under an Enforcement Point Read an 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}
Patch a Policy Edge Cluster Patch a policy edge cluster. It only supports homogeneous members. The Edge Transport Nodes are only allowed in cluster members. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these Edge Nodes is recommended to be the same. Any update operation on members of edge cluster is not permitted, To replace the edge transport node for an existing member, refer /policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/ /action/replace-policy-edge-node api.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}
Create Or Update a Policy Edge Cluster Edge Cluster only supports homogeneous members. The Edge Transport Nodes are only allowed in cluster members. DeploymentType of these edge nodes can be VIRTUAL_MACHINE or PHYSICAL_MACHINE. Any update operation on members of edge cluster is not permitted, To replace the edge transport node for an existing member, refer /policy/api/v1/infra/sites/default/enforcement-points/default/edge-clusters/ /action/replace-policy-edge-node API.	PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}
Relocate service contexts from policy edge node and remove policy edge node from the edge-cluster Relocate auto allocated service contexts from policy edge node at given id. For API to perform relocate and remove action the edge node at given id must only have auto allocated service contexts. If any manually allocated service context is present on the edge cluster member, then the task will not be performed. Also, it is recommended to move the edge node for which relocate and remove action is being performed into maintenance mode,before executing the API. If edge is not moved into maintenance mode, then API will move edge node into maintenance mode before performing the actual relocate and remove task.To maintain high availability, Edge cluster should have at least two healthy edge nodes for relocation and removal. Once relocate action is performed successfully, the policy edge node will be removed from the edge cluster.	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/action/relocate-and-remove-edge-transport-node
Replace the policy edge node at the specified member-index in the edge-cluster Replace the Policy Edge Node present at the specified member-index in the edge-cluster. This is a disruptive action. This will move all the Interfaces(uplink and routerLink) hosted on the old Policy Edge Node to the new Policy Edge Node. The same Policy Edge Node cannot be present as a member of any edge cluster.	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/action/replace-edge-transport-node
Get a Policy Edge Cluster allocation status under an Enforcement Point Returns the allocation details of cluster and its members. Lists the edge node members, active and standby services of each node, utilization details of configured sub-pools. These allocation details can be monitored by customers to trigger migration of certain service contexts to different edge nodes, to balance the utilization of edge node resources.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/allocation/status GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/allocation/status
List Edge Nodes under an Enforcement Point, Edge Cluster Paginated list of all Edge Nodes under an Enforcement Point, Edge Cluster	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes
Read an Edge Node under an Enforcement Point, Edge Cluster Read an Edge Node under an Enforcement Point, Edge Cluster	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes/{edge-node-id} GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/edge-nodes/{edge-node-id}
Get a Policy Edge Cluster State info under an Enforcement Point Returns information about the current state of the edge cluster.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/state
Get a Policy Edge Cluster real time status under an Enforcement Point Returns the aggregated status for the Edge cluster along with status of all edge nodes in the cluster. Query parameter "source=realtime" is the only supported source.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/status GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-clusters/{edge-cluster-id}/status
List Edge Transport Node under an Enforcement Point List Edge Transport Nodes under an Enforcement Point	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes
Delete Edge Transport Node Delete Edge Transport Node.	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}
Read an Edge Transport Node under an Enforcement Point Read an Edge Transport Node under an Enforcement Point	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}
Patch a new LCM Edge Transport Node under Enforcement Point If the passed Edge Transport Node does not already exist, create a new Edge Transport Node. If it already exists, patch it.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}
Create or update a LCM Edge Transport Node under Enforcement Point If the passed Edge Transport Node does not already exist, create a new Edge Transport Node. If it already exists, update it.	PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}
Policy Edge Transport Node Enter Maintenance Mode Action API Put edge transport node into maintenance mode if there is no VIFs attached. When EdgeTransportNode is in maintenance mode, no configuration changes are allowed.	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/action/enter-maintenance-mode
Policy Edge Transport Node Exit Maintenance Mode Action API This APi will exit from maintenance mode	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/action/exit-maintenance-mode
Redeploy Edge Transport Node Redeploys an edge transport node at NSX Manager that replaces the edge transport node with identifier <node-id>. If NSX Manager can access the specified edge node, then the node is put into maintenance mode and then the associated VM is deleted. This is a means to reset all configuration on the edge node. The communication channel between NSX Manager and edge is established after this operation.	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/action/redeploy
List the specified edge transport node's network interfaces. Returns the number of interfaces on the edge transport node and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/network/interfaces
Read counters for edge transport node interfaces. This API returns the counters of the specified interface. The counters reset on reboot or redeploy of the appliance or restart of the data plane. NSX Manager polls the edge-transport-node every minute (by default) to update the data returned on this API. If you need near realtime values, use the query parameter \"?source=realtime\" to the API and it will make NSX Manager collect the statistics from the edge transport node and returns the updated counters.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/network/interfaces/{interface-id}/statistics
Get a Policy EdgeTransport Node's State info under an Enforcement Point Returns information about the current state of the edge transport node configuration and information about the associated edge tn switches.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/state
Get a Policy EdgeTransport Node's status info under an Enforcement Point Returns information about the current status of the edge transport node.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/{edge-transport-node-id}/status
Get a Policy EdgeTransport Node's State info under an Enforcement Point Returns information about the current state of the edge transport node configuration and information about the associated edge tn switches.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/state
Get high-level summary of all edge transport nodes. The service layer does not support source = realtime or cached.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/edge-transport-nodes/status
List Policy Failure Domains Creates a new Policy failure domain.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/failure-domains
Delete a Failure Domain Deletes an existing failure domain. You can not delete system generated default failure domain.	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/failure-domains/{failure-domain-id}
Get a Failure Domain Creates a new Policy failure domain.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/failure-domains/{failure-domain-id}
Patch a Policy FailureDomain Patch a Policy FailureDomain.	PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/failure-domains/{failure-domain-id}
Update a Failure Domain Create or Update a failure domain. Modifiable parameters are display_name, preferred_active_edge_services flag.	PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/failure-domains/{failure-domain-id}