Get Universal Routes

Get Universal Routes

Retrieves routing configuration for a Universal Router.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/routing/routes
COPY
Path Parameters
string
universalRouterId
Required

universalRouterId

string
universalRouterId
Required

universalRouterId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UniversalRoutes of type(s) application/json;version=39.0 
{
    "keepAliveTimer": 0,
    "values": [
        {
            "defaultEgress": {
                "egressPointId": "string",
                "vdcRef": {
                    "name": "string",
                    "id": "string"
                },
                "gatewayRef": {
                    "name": "string",
                    "id": "string"
                }
            },
            "standbyEgress": {
                "egressPointId": "string",
                "vdcRef": {
                    "name": "string",
                    "id": "string"
                },
                "gatewayRef": {
                    "name": "string",
                    "id": "string"
                }
            },
            "networkProviderScope": "string",
            "status": {},
            "errorMessage": "string"
        }
    ],
    "providerScopesToForceUnconfigure": [
        "string"
    ]
}
integer
keepAliveTimer
Optional

The Keep Alive Timer is the frequency (in seconds) at which the Universal Router seeds Keep Alive messages to its egress peers.

array of UniversalRoute
values
Optional

The list of Universal Routes.

array of string
providerScopesToForceUnconfigure
Optional

The list network provider scopes whose route will be unconfigure forcefully. This means that a route that is in state that normally shouldn't be unconfigurable (i.e. NSX or remote vCD site is down) will still be unconfigured. Errors may be ignored. Note that this force option also affects any route update where a network provider's egress point is modified/changed. vCD will first unconfigure any existing egress point before configuring the new egress point.


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


On This Page
Universal Routing Operations
GET
Get Universal Egress Routing
GET
Get Universal Routes
POST
Sync Universal Routes
PUT
Update Universal Egress Routing
PUT
Update Universal Routes