Update a Route

put

/network/v1/route/{name}

You can update the following parameter values for a route: IP address of the destination, vNICset that provides the next hop for routing packets, and the route's administrative distance.

Required Role: To complete this task, you must have the Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types
Path Parameters
  • The three-part name (/Compute-identity_domain/user/object) of the route.
Header Parameters
Body ()
The request body contains details of the route that you want to update.
Root Schema : Route-put-request
Type: object
The request body contains details of the route that you want to update.
Show Source
  • Specify 0,1, or 2 as the route's administrative distance. If you do not specify a value, the default value is 0.

    The same prefix can be used in multiple routes. In this case, packets are routed over all the matching routes with the lowest administrative distance. In case there are multiple routes with the same lowest administrative distance, routing occurs over all these routes using ECMP.

  • Description of the object.
  • The IPv4 address prefix, in CIDR format, of the destination.
  • The three-part name (/Compute-identity_domain/user/object) that you want to update.

    Object names can contain only alphanumeric, underscore (_), dash (-), and period (.) characters. Object names are case-sensitive.

  • Three-part name (/Compute-identity_domain/user/object) of the virtual NIC set to route matching packets to. Routed flows are load-balanced among all the virtual NICs in the virtual NIC set.
  • tags
    Tags associated with the object.
Nested Schema : tags
Type: array
Tags associated with the object.
Show Source

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Headers
Body ()
Root Schema : Route-response
Type: object
Show Source
Nested Schema : tags
Type: array
Tags associated with the object.
Show Source

Examples

cURL Command

The following example shows how to update a route, /Compute-acme/jack.jones@example.com/route1, by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -i -X PUT
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
     -d "@requestbody.json"
        https://api-z999.compute.us0.oraclecloud.com/network/v1/route/Compute-acme/jack.jones@example.com/route1
  • COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

  • api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

  • acme and jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file to modify the values of nextHopVnicSet, ipAddressPrefix, and adminDistance for the /Compute-acme/jack.jones@example.com/route1 route.

Some lines may be truncated with ellipses (...) for readability.

{
 "name": "/Compute-acme/jack.jones@example.com/route1",
 "nextHopVnicSet": "/Compute-acme/jack.jones@example.com/vnicset2",
 "ipAddressPrefix": "10.40.80.0/20",
 "adminDistance": 2
}

Example of Response Body

The following example shows the response body in JSON format when you update a route.

{
  "name": "/Compute-acme/jack.jones@example.com/route1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/route/Compute-acme/jack.jones@example.com/route1",
  "description": null,
  "tags": null,
  "nextHopVnicSet": "/Compute-acme/jack.jones@example.com/vnicset2",
  "ipAddressPrefix": "10.40.80.0/20",
  "adminDistance": 2
}