[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Create Edge Gateway

Description

Create a new edge gateway for a vDC. Only NSX-T Edge Gateways can be created with this endpoint.

Request

Request

URL

URL


post
https://{api_host}/cloudapi/1.0.0/edgeGateways
Copy

Request Body

Request Body

EdgeGateway of type(s) application/json Required
This request body class requires all of the following: NetworkingObjectStatus, InlineEdgeGateway1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

Errors

Errors

Error
400

Invalid configuration.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"description":"string","distributedRouterUplinkNetworkDefinition":"string","distributedRoutingEnabled":false,"edgeClusterConfig":{"primaryEdgeCluster":{"backingId":"string","edgeClusterRef":{"id":"string","name":"string"}},"secondaryEdgeCluster":{"backingId":"string","edgeClusterRef":{"id":"string","name":"string"}}},"edgeGatewayUplinks":[{"connected":false,"dedicated":false,"quickAddAllocatedIpCount":0,"subnets":{"values":[{"autoAllocateIpRanges":false,"dnsServer1":"string","dnsServer2":"string","dnsSuffix":"string","enabled":false,"gateway":"string","ipRanges":{"values":[{"endAddress":"string","startAddress":"string"}]},"prefixLength":0,"primaryIp":"string","totalIpCount":0,"usedIpCount":0}]},"uplinkId":"string","uplinkName":"string","vrfLiteBacked":false}],"gatewayBacking":{"backingId":"string","gatewayType":"enum","networkProvider":{"id":"string","name":"string"}},"id":"string","name":"string","nonDistributedRoutingEnabled":false,"orgRef":{"id":"string","name":"string"},"orgVdc":{"id":"string","name":"string"},"orgVdcNetworkCount":0,"ownerRef":{"id":"string","name":"string"},"serviceNetworkDefinition":"string","status":"enum"}' https://{api_host}/cloudapi/1.0.0/edgeGateways


[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 32.0
Edge Gateways Operations
Feedback

Was this page helpful?