Get Static Routes

Get Static Routes

Retrieves all static routes configured for the Edge Gateway.

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

gatewayId

string
gatewayId
Required

gatewayId

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.
Responses
200

OK

Returns GatewayStaticRoutes of type(s) application/json;version=39.0 
{
    "values": [
        {
            "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
            },
            "routeAdvertised": false
        }
    ]
}
array of GatewayStaticRoute
values
Optional

values


Availability
Added in 37.0
Deprecated in 38.1
With alternative: see
See /cloudapi/2.0.0/edgeGateways/{gatewayId}/routing/staticRoutes
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