​

ves-io-schema-topology-CustomDataAPI-GetRouteTable

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing topology CustomDataAPI GetRouteTable

Usecase:

Get route table rt-1

Request:

Request using vesctl:

vesctl request rpc topology.CustomDataAPI.GetRouteTable -i request.yaml --uri /public/namespaces/system/topology/route_table/rt-1 --http-method GET

where file request.yaml has following contents:

{}

vesctl yaml response:

metadata:
  name: rt-1
  tags: {}
routeTable:
  associations: []
  explicitSubnet: []
  implicitSubnet: []
  network: []
  propagations: []
  routes:
  - destination: 10.0.0.0/24
    nexthop: igw-1
  - destination: 0.0.0.0/0
    nexthop: igw-1
  subnet: []
  transitGateway: []

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/data/namespaces/system/topology/route_table/rt-1?name='

curl response:

HTTP/1.1 200 OK
Content-Length: 918
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:30:29 GMT
Vary: Accept-Encoding


{
  "metadata": {
    "name": "rt-1",
    "tags": {
    },
    "cloud_resource_id": ""
  },
  "route_table": {
    "subnet": [
    ],
    "network": [
    ],
    "transit_gateway": [
    ],
    "routes": [
      {
        "destination": "10.0.0.0/24",
        "nexthop": "igw-1",
        "source": "INVALID_SOURCE",
        "state": "ACTIVE_STATE",
        "next_hop_type": "VIRTUAL_NETWORK_GATEWAY",
        "user_defined_route_name": ""
      },
      {
        "destination": "0.0.0.0/0",
        "nexthop": "igw-1",
        "source": "INVALID_SOURCE",
        "state": "ACTIVE_STATE",
        "next_hop_type": "VIRTUAL_NETWORK_GATEWAY",
        "user_defined_route_name": ""
      }
    ],
    "route_table_type": "ROUTE_TABLE_NETWORK",
    "implicit_subnet": [
    ],
    "explicit_subnet": [
    ],
    "route_table_state": "ROUTE_TABLE_STATE_NONE",
    "associations": [
    ],
    "propagations": [
    ]
  }
}
On this page: