NSX-T Data Center REST API
Associated URIs:
| API Description | API Path |
|---|---|
Returns configuration information for all gateways |
GET /api/v1/csm/aws/gateways
|
Deploys gateway for the specified VPCAll the required configuration to deploy AWS 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 GetAwsGatewayStatus API. Upon successful deployment of a gateway, the deployment_step will be DEPLOYMENT_SUCCESSFUL gateway_status will be UP and op_status of the VPC 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 VPC using transit VPC, user needs to undeploy gateway and onboard the compute VPC using /csm/aws/vpcs/<vpc-id>?action=onboard API. |
POST /api/v1/csm/aws/gateways?action=deploy
|
Undeploys gateway for the specified VPCAll the required configuration to undeploy AWS 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 GetAwsGatewayStatus 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/aws/gateways?action=undeploy
|
Returns configuration for primary gateway and secondary gateway for the vpc,if exists. |
GET /api/v1/csm/aws/gateways/<vpc-id>
|
Updates configuration for primary gateway and secondary gateway for the vpc, if exists. |
PUT /api/v1/csm/aws/gateways/<vpc-id>
|
Returns status information for primary gateway and secondary gateway for the vpc, if exists. |
GET /api/v1/csm/aws/gateways/<vpc-id>/status
|