Update Static Route

Update Static Route

Updates a specific static route configured on an Edge Gateway.

Request
URI
PUT
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

Request Body
GatewayStaticRoute of type(s) application/json
Optional 
{
    "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
}
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 GatewayStaticRouteNextHop
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

This property describes the current version of the entity. To prevent clients from overwriting each other's changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.

boolean
routeAdvertised
Optional

A flag indicating whether the static route network CIDR should be route advertised. Only applies to IP Spaces Edge Gateways. If set to true, the Edge Gateway will advertise this route to the connected Provider Gateway. If the network CIDR is advertised, it will be advertised irrespective of how many routes are there for same network CIDR.

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

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