NSX-T Data Center REST API

Associated URIs:

API Description API Path

List of VPC


Paginated list of VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs

Delete VPC and its children


Delete VPC.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}

Get VPC


Get VPC
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}

Create or update VPC


If a VPC with the vpc-id is not already present, create a new VPC.
If it already exists, update the VPC.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}

Update the VPC


Update the VPC.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}

Manual failover of the active-standby VPC gateway to the preferred edge node


The API is only supported if gateway high availability mode is active/standby and using non-preemptive failover mode.
The preferred edge node must be one of the two node paths where a gateway already exists.
To check existing edge nodes and their high availability status, refer to the VPC gateway state API.
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/actions/failover

Get ip address usage for vpc


Retrieves the usage information for IP addresses within a specific VPC. This information provides insights into the allocation
and utilization of ipaddress by the VPC and its subnets.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-usage

Get realization failures for vpc


Retrieves only the resources with the reason not "SUCCESS". In case of failure or warning of the resource a reason object explaining the type of failure (ERROR, WARNING)
and the detailed message of what the user could do to remediate is captured.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/realization-failures (Experimental)

Get VPC state


Get the VPC's runtime state that includes the gateway id and the HA details, if applicable.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/state

Get VPC Statistics


Get VPC Statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/statistics

Get VPC Status


Get VPC Status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/status (Experimental)