Create a Route

post

/network/v1/route/

Creates a route, which specifies the IP address of the destination as well as a vNICset which provides the next hop for routing packets.

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
Header Parameters
Body ()
The request body contains details of the route that you want to create.
Root Schema : Route-post-request
Type: object
The request body contains details of the route that you want to create.
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 the case multiple routes with the same lowest administrative distance match, routing occurs over all these routes using ECMP.

  • Description of the object.
  • The IPv4 address prefix, in CIDR format, of the external network (external to the vNIC set) from which you want to route traffic.
  • The three-part name (/Compute-identity_domain/user/object) of the route.

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

  • Name 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

201 Response

Created. 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 create a route by submitting a POST 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 POST
     -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_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.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file.

{
 "name": "/Compute-acme/jack.jones@example.com/route1",
 "nextHopVnicSet": "/Compute-acme/jack.jones@example.com/vnicset1",
 "ipAddressPrefix": "10.33.88.0/24"
}

Example of Response Body

The following example shows the response body in JSON format.

{
  "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/vnicset1",
  "ipAddressPrefix": "10.33.88.0/24",
  "adminDistance": 0
}