GET Site Networks.

GET

/api/data/namespaces/system/topology/site/{name}/networks

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/topology/site/example/networks';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/topology/site/example/networks \
  --header 'Authorization: <Authorization>'

Gets Networks Associated to Site.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

name

required

string

Name

x-required Site name.

Responses

200

A successful response.

application/json

Site Networks Response

List of Networks Associated to Site.

object

aws

object

metadata

object

creds

Cloud Credentials

Reference to cloud credentials to fetch cloud resources.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

ID in the external system (such as cloud specific ID).

string

>= 1 <= 4094 <= 1024 characters

name

Name

Name in the external system.

string

>= 6 characters <= 1024 characters

owner_id

OwnerID

Owner ID in the cloud side.

string

<= 1024 characters

provider_type

string

default: PROVIDER_TYPE_UNSPECIFIED

Allowed values: PROVIDER_TYPE_UNSPECIFIED PROVIDER_TYPE_AWS PROVIDER_TYPE_GCP PROVIDER_TYPE_AZURE PROVIDER_TYPE_VOLTERRA PROVIDER_TYPE_VMWARE PROVIDER_TYPE_KVM PROVIDER_TYPE_OCI PROVIDER_TYPE_BAREMETAL PROVIDER_TYPE_F5RSERIES PROVIDER_TYPE_K8S

raw_json

Raw JSON

Raw JSON string.

string

<= 1024 characters

status

Status

Status of topology node.

string

>= 17 characters <= 1024 characters

tags

tags

Map of string keys and values that annotated in the topology node.

object

transit_gateway

object

attachments

Attachments

TGW Attachements.

Array<object>

AWSTGWAttachment

AWS TGW Attachment.

object

associated_route_table_id

Associated Route Table ID

Associated Route Table ID.

string

<= 1024 characters

association_state

Association State

Association State.

string

<= 1024 characters

cidr

CIDR

Configuration parameter for cidr

string

<= 1024 characters

cloud_connect

Cloud Connect

Reference to the Cloud Connect.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

TGW Attachment ID.

string

>= 1 <= 4094 <= 1024 characters

name

Name

TGW Attachment Name.

string

>= 6 characters <= 1024 characters

resource_id

Resource ID

Resource ID.

string

<= 1024 characters

resource_name

Resource Name

Resource Name.

string

<= 1024 characters

resource_type

Resource Type

Resource Type.

string

<= 1024 characters

segment

Segment

Reference to the Segment.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

auto_accept_shared_attachments

Auto accept shared attachment

Auto accept shared attachment.

boolean format: boolean

dns_support

DNS support

DNS support.

boolean format: boolean

network

Network

Reference to the network.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

vpn_ecmp_support

vpn ecmp support

VPN ecmp support.

boolean format: boolean

routes_metadata

Network Routes Meta Data

Network Routes Meta Data.

Array<object>

NetworkRoutesMetaData

Metadata associated with the network routes.

object

cloud_resource_id

Cloud Resource Id

Cloud Resource ID.

string

<= 1024 characters

Network Id

Network ID.

string

>= 1 <= 4094 <= 1024 characters

name

Network Name

Network Name.

string

>= 6 characters <= 1024 characters

network_type

string

default: NETWORK_TYPE_NONE

Allowed values: NETWORK_TYPE_NONE NETWORK_TYPE_HUB_VNET NETWORK_TYPE_SPOKE_VNET NETWORK_TYPE_SERVICE_VPC NETWORK_TYPE_SPOKE_VPC

regions

Regions

Regions in Network.

Array<string>

route_tables_metadata

Network Route Tables Metadata

Network Route Tables Metadata.

Array<object>

NetworkRouteTableMetaData

Metadata associated with the network route tables.

object

route_table_metadata

object

cloud_resource_id

Cloud Resource Id

Cloud Resource Identifier this route table.

string

<= 1024 characters

name

Name

Name of the route table.

string

>= 6 characters <= 1024 characters

tags

tags

Map of string keys and values that annotated in the topology node.

object

subnet_metadata

Subnet Metadata

Subnet Metadata.

Array<object>

SubnetMetaData

Metadata associated with the subnets.

object

cidr_v4

IPv4 Cidr

IPv4 CIDR

Array<string>

cidr_v6

IPv6 Cidr

IPv6 CIDR

Array<string>

cloud_resource_id

Cloud Resource Id

Cloud Resource Identifier the subnet.

string

<= 1024 characters

name

Name

Name of the subnet.

string

>= 6 characters <= 1024 characters

Example

{
  "aws": {
    "metadata": {
      "provider_type": "PROVIDER_TYPE_UNSPECIFIED"
    }
  },
  "routes_metadata": [
    {
      "network_type": "NETWORK_TYPE_NONE"
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

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

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

GET Site Networks.

Authorizations

Parameters

Path Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated