Update Universal Egress Routing

Update Universal Egress Routing

Updates the routing configuration using the specified egress points in the universal routes. Any egress point that does not exist will be created before updating routing. Any egress point that currently exists and is not in use by any of the specified routes will be deleted. If the new egress points for routing fail to create, routing will not be updated.

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

universalRouterId

string
universalRouterId
Required

universalRouterId

Request Body
UniversalEgressRoutes of type(s) application/json
Required 
{
    "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"
        ]
    }
}
EgressPoints
egressPoints
Optional

List of Egress Points.

UniversalRoutes
universalRoutes
Optional

List of routes associated with a Universal Router.

Authentication
This operation uses the following authentication methods.
Responses
202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

400

Invalid configuration.

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

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


404

The specified resource was not found

Returns Error of type(s) */*;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