Show Routes.

POST

/api/operate/namespaces/{namespace}/sites/{site}/ver/routes

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/ver/routes \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "cluster_wide": {}, "family": "INET4", "namespace": "example", "node": "example", "prefix": { "prefix": [ "example" ] }, "segment": "example", "site": "example", "vn": "example", "vn_type": "VIRTUAL_NETWORK_SITE_LOCAL" }'

• F5 Distributed Cloud Console

Show VER routes matching the request.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace for which the request is sent (system)

site

required

string

Site Name Name of the site for which request is sent.

Request Body^required

Media typeapplication/json

Route Request

Request to GET list of VER routes matching the request.

object

cluster_wide

object

family

string

default: INET4

Allowed values: INET4 INET6

namespace

Namespace

Namespace for which the request is sent (system)

string

>= 6 characters <= 1024 characters

node

Node Name

Exclusive with [cluster_wide] Fetch routes from this node.

string

>= 1 characters <= 64 characters

prefix

object

prefix

Prefix

IP Address prefix in string format. String must contain both prefix and prefix-length.

Array<string>

<= 256 items

segment

Segment name

Exclusive with [vn vn_type] Name of Segment for which routes are required.

string

<= 1024 characters

site

Site Name

Name of the site for which request is sent.

string

<= 1024 characters

vn

Virtual Network Name

Exclusive with [segment vn_type] Name of Virtual Network for which routes are required.

string

<= 1024 characters

vn_type

string

default: VIRTUAL_NETWORK_SITE_LOCAL

Allowed values: VIRTUAL_NETWORK_SITE_LOCAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE VIRTUAL_NETWORK_PER_SITE VIRTUAL_NETWORK_PUBLIC VIRTUAL_NETWORK_GLOBAL VIRTUAL_NETWORK_SITE_SERVICE VIRTUAL_NETWORK_VER_INTERNAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE VIRTUAL_NETWORK_IP_AUTO VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK VIRTUAL_NETWORK_SRV6_NETWORK VIRTUAL_NETWORK_IP_FABRIC VIRTUAL_NETWORK_SEGMENT VIRTUAL_NETWORK_MANAGEMENT

Responses

200

A successful response.

Media typeapplication/json

Route Response

List of routes from ver instances in the site.

object

ver_routes

Ver Routes

Routes from ver instance.

Array<object>

Routes

Matching routes from VER.

object

node

Ver Hostname

Host name of VER instance.

string

<= 1024 characters

route

Route Info

Route information.

Array<object>

Route Information

Route information.

object

flags

Flags

Route Flags.

string

<= 1024 characters

label

Label

Associated Label.

integer format: int64

nh

Nexthop

Nexthop identifier.

integer format: int64

nh_info

Nexthop Info

Nexthop information.

string

<= 1024 characters

prefix

Prefix

Route prefix.

string

<= 1024 characters

Example^generated

{
  "ver_routes": [
    {
      "node": "example",
      "route": [
        {
          "flags": "example",
          "label": 1,
          "nh": 1,
          "nh_info": "example",
          "prefix": "example"
        }
      ]
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example