NSX-T Data Center REST API

Associated URIs:

API Description API Path

List Tier-0s


Paginated list of all Tier-0s
GET /policy/api/v1/infra/tier-0s
GET /policy/api/v1/global-infra/tier-0s

Recover of Tier0 and linked tier1 gateway(s).


API to recover specified Tier0 gateway and linked tier1 gateway from
primary site path to new primary site path. This will update intent of
affected Tier-0 and Tier-1 gateway.
POST /policy/api/v1/infra/tier-0s?action=site_failover

Delete Tier-0


Delete Tier-0
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}

Read Tier-0


Read Tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}

Create or update a Tier-0


If a Tier-0 with the tier-0-id is not already present, create a new
Tier-0. If it already exists, update the Tier-0 for specified attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}

Reprocess Tier0 gateway configuration and publish updates to NSX controller


Reprocess Tier0 gateway configuration and configuration of related entities like Tier0 interfaces
and static routes, etc. Any missing Updates are published to NSX controller.
POST /policy/api/v1/infra/tier-0s/{tier-0-id}?action=reprocess

Create or update a Tier-0


If a Tier-0 with the tier-0-id is not already present, create a new
Tier-0. If it already exists, replace the Tier-0 instance with the new object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}

Manual failover of the active-standby tier0 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 tier0 gateway state API.
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/actions/failover
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/actions/failover