NSX-T Data Center REST API

Associated URIs:

API Description API Path

Returns configuration information for all Azure gateways


Returns a list of Azure gateways with information about each gateway like
subnet configuration and corresponding virtual network. Optional query
parameters can be utilized to filter the list.
GET /api/v1/csm/azure/gateways

Undeploys gateway for the specified virtual network


All the required configuration to undeploy Azure gateway will be absorbed
as a part of request body in this API and gateway undeployment will be
triggered. Undeployment progress can be known from GetAzureGatewayStatus
API. Upon successful undeployment of a gateway, the deployment_step will be
UNDEPLOYMENT_SUCCESSFUL and gateway_status will be NOT_AVAILABLE. If any
error is encountered during undeployment, corresponding error_code and
error_message will be populated in gateway_instances_status
POST /api/v1/csm/azure/gateways?action=undeploy

Deploys gateway for the specified virtual network


All the required configuration to deploy Azure gateways will be absorbed
as a part of request body in this API and gateway deployment will be
triggered. Deployment progress can be known from GetAzureGatewayStatus API.
Upon successful deployment of a gateway, the deployment_step will be
DEPLOYMENT_SUCCESSFUL gateway_status will be UP and op_status of the VNET
will be NSX_MANAGED_BY_GATEWAY. If any error is encountered during
deployment, corresponding error_code and error_message will be populated
in gateway_instances_status. To manage a compute VNET using transit VNET,
user needs to undeploy gateway and onboard the compute VNET
using /csm/azure/vnets/<vnet-id>?action=onboard API.
POST /api/v1/csm/azure/gateways?action=deploy

Returns configuration of the Azure gateway


Returns configuration for primary gateway and secondary gateway for the
virtual network, if deployed gateways exist for the specified virtual
network.
GET /api/v1/csm/azure/gateways/<vnet-id>

Updates Azure gateway configuration


Updates configuration for primary gateway and secondary gateway for the
virutal network, if deployed gateways exist for the specified virtual network.
PUT /api/v1/csm/azure/gateways/<vnet-id>

Return the status of Azure gateway


Returns status information for primary gateway and secondary gateway
for the virtual network, if deployed gateways exist for the specified
virtual network ID.
GET /api/v1/csm/azure/gateways/<vnet-id>/status