Get Universal Egress Routing

Get Universal Egress Routing

Retrieves Universal Egress Points and routing configuration for a Universal Router.

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

universalRouterId


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UniversalEgressRoutes of type(s) application/json;version=39.1
{
    "egressPoints": {
        "values": [
            {
                "id": "string",
                "vdcRef": {
                    "name": "string",
                    "id": "string"
                },
                "gatewayRef": {
                    "name": "string",
                    "id": "string"
                },
                "networkProviderScope": "string",
                "isUsedForRouting": false,
                "status": {},
                "errorMessage": "string"
            }
        ]
    },
    "universalRoutes": {
        "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"
        ]
    }
}
object
egressPoints
Optional

List of Egress Points.

object
universalRoutes
Optional

List of routes associated with a Universal Router.


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.1
"Error Object"
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/routing