Get Static Route

Get Static Route

Retrieves a specific static route configured on an Edge Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/staticRoutes/{routeId}
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
routeId
Required

routeId

string
gatewayId
Required

gatewayId

string
routeId
Required

routeId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeStaticRoute of type(s) application/json;version=38.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "networkCidr": "10.22.0.0/22",
    "nextHops": [
        {
            "ipAddress": "string",
            "adminDistance": 0,
            "scope": {
                "name": "string",
                "scopeType": "string",
                "id": "string"
            }
        }
    ],
    "systemOwned": false,
    "version": {
        "version": 0
    }
}
string
id
Optional

The unique ID of this static route. On updates, the ID is required for the object, while for create a new ID will be generated. This ID is not a VCD URN.

string
name
Required

Name for the static route.

string
description
Optional

Description for this static route.

string
networkCidr
Required

The network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.

array of EdgeStaticRouteNextHop
nextHops
Required

The list of next hops to use within the static route. List must contain at least one valid next hop.

boolean
systemOwned
Optional

A flag indicating whether this static route is managed by the system. Property is read-only.

ObjectVersion
version
Optional

version


Availability
Added in 37.0
On This Page
Edge Gateway Static Routes Operations
POST
Create Static Route
DELETE
Delete Static Route
GET
Get Static Route
GET
Get Static Routes
PUT
Update Static Route