Changed1

[{"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

Get Static Routes

Description

Retrieves all static routes configured for the edge gateway.

Request

URL

get

https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/staticRoutes

Copy

Path Parameters

string

gatewayId Required

Query Parameters

string

cursor Optional

Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored.

integer

pageSize Required

Results per page to fetch.

string

sortAsc Optional

Field to use for ascending sort

string

sortDesc Optional

Field to use for descending sort

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns EdgeStaticRoutes of type(s) application/json;version=37.0

{
	"values": [
		{
			"description": "string",
			"id": "string",
			"name": "string",
			"networkCidr": "10.22.0.0/22",
			"nextHops": [
				{
					"adminDistance": 0,
					"ipAddress": "string",
					"scope": {
						"id": "string",
						"name": "string",
						"scopeType": "string"
					}
				}
			],
			"systemOwned": false,
			"version": {
				"version": 0
			}
		}
	]
}

array of EdgeStaticRoute

values Optional

A static route configuration.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/staticRoutes?pageSize=10

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vcloud-default-sort:
    default-sort-field: name
    sort-ascending: true

vmware-cloud-director

What's changed in v37.0?

INTRODUCED

Availability

Added in 37.0

Edge Gateway Static Routes Operations

post

Create Static Route Introduced

delete

Delete Static Route Introduced

get

Get Static Route Introduced

get

Get Static Routes Introduced

put

Update Static Route Introduced

Get Static Routes

Request

URL

Path Parameters

Query Parameters

Authentication

ApiKeyAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Vendor Extensions

What's changed in v37.0?

Availability

On This Page

Edge Gateway Static Routes Operations

Was this page helpful?