NSX-T Data Center REST API

Associated URIs:

API Description API Path

List Deployment Zones for infra


Paginated list of all Deployment zones for infra.
GET /policy/api/v1/infra/deployment-zones (Deprecated)

Read a DeploymentZone


Read a Deployment Zone.
GET /policy/api/v1/infra/deployment-zones/{deployment-zone-id} (Deprecated)

Get site offboarding status.


Get site offboarding status.
GET /policy/api/v1/infra/site/offboarding-status

List Sites


List Sites under Infra.
GET /policy/api/v1/infra/sites
GET /policy/api/v1/global-infra/sites

Delete a site


Delete a site under Infra.
DELETE /policy/api/v1/infra/sites/{site-id}

Read a site


Read a site under Infra.
GET /policy/api/v1/infra/sites/{site-id}
GET /policy/api/v1/global-infra/sites/{site-id}

Create or patch Site


Create or patch Site under Infra.
PATCH /policy/api/v1/infra/sites/{site-id}

Create or fully replace a Site under infra


Create or fully replace a Site under Infra.
Revision is optional for creation and required for update.
PUT /policy/api/v1/infra/sites/{site-id}

Returns the certificate of the listener


Connects to the given IP and port, and, if an SSL listener is present, returns
the certificate of the listener.
Intent of this API is "Do you trust this certificate?".
GET /policy/api/v1/infra/sites/listener_certificate
GET /policy/api/v1/global-infra/sites/listener_certificate

Get span for an entity with specified path


Get span for an entity with specified path.
GET /policy/api/v1/infra/span
GET /policy/api/v1/global-infra/span
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/span

Get the site configuration


GET /api/v1/sites

Get the site configuration, some attributes won't be shown based on version


GET /api/v1/sites?version=3.0.2
GET /api/v1/sites?version=3.1.0
GET /api/v1/sites?version=latest

Get the compatibility list of the site


Returns the version of this site and list of compatible versions
GET /api/v1/sites/compatibility

Check whether the remote site version is compatible to this site


Returns the version of this site and list of compatible versions for both local and remote site,
also a boolean indicating whether the two are compatible, this value is true if one of the site
version is in the compatibility list of the other site
GET /api/v1/sites/compatibility/remote

Get the local site configuration


GET /api/v1/sites/self

Get overall status of the federation, including stub status


GET /api/v1/sites/status

Get the switchover status


GET /api/v1/sites/switchover-status