Skip to content
API Enriched

Show BGP Routes.

GET
/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes
curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/ver/bgp_routes \
  --header 'Authorization: <Authorization>'

Show routes exported / imported via BGP.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace for which the request is sent (system)

site
required
string

Site Name Name of the site.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
BGP Routes Response

All BGP routes per instance per table from all ver instances in the site.

object
ver
Ver Routing Instances

Routes per instance per table from each ver instance.

Array<object>
Ver Instance BGP Routes

All BGP routes per instance per table from a ver instance.

object
name
Ver Name

Host name of VER instance.

string
>= 6 characters <= 1024 characters
ri_table
Routing Instances

Routes per instance per table.

Array<object>
Routing Instance Table

BGP tables per instance.

object
routing_instance
Routing Instance

Name of the routing instance.

string
<= 1024 characters
rt_table
Tables

Routes per table.

Array<object>
BGP Route Table

A route table.

object
exported
Exported Routes

List of Routes exported via BGP.

Array<object>
BGP Route

A BGP route.

object
path
Paths

All the route paths.

Array<object>
BGP Path

A BGP path.

object
as_path
AS Path

AS Path attribute.

string
<= 1024 characters
local_pref
Local Preference

Local preference attribute.

integer format: int64
med
Med

Med attribute.

integer format: int64
nh
Nexthop

Nexthops of the path.

Array<string>
peer
Peer

Peer from which the path is received.

string
<= 1024 characters
subnet
Subnet

Prefix / Plen of the route.

string
<= 1024 characters
imported
Imported Routes

List of Routes imported via BGP.

Array<object>
BGP Route

A BGP route.

object
path
Paths

All the route paths.

Array<object>
BGP Path

A BGP path.

object
as_path
AS Path

AS Path attribute.

string
<= 1024 characters
local_pref
Local Preference

Local preference attribute.

integer format: int64
med
Med

Med attribute.

integer format: int64
nh
Nexthop

Nexthops of the path.

Array<string>
peer
Peer

Peer from which the path is received.

string
<= 1024 characters
subnet
Subnet

Prefix / Plen of the route.

string
<= 1024 characters
name
Table Name

Name of the table.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
  "ver": [
    {
      "name": "example",
      "ri_table": [
        {
          "routing_instance": "example",
          "rt_table": [
            {
              "exported": [
                {
                  "path": [
                    {
                      "as_path": "example",
                      "local_pref": 1,
                      "med": 1,
                      "nh": [
                        "example"
                      ],
                      "peer": "example"
                    }
                  ],
                  "subnet": "example"
                }
              ],
              "imported": [
                {
                  "path": [
                    {
                      "as_path": "example",
                      "local_pref": 1,
                      "med": 1,
                      "nh": [
                        "example"
                      ],
                      "peer": "example"
                    }
                  ],
                  "subnet": "example"
                }
              ],
              "name": "example"
            }
          ]
        }
      ]
    }
  ]
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example