Skip to main content

Retrieve VPCs

GET /vsa/metadata/vpcs

Retrieves VPCs.

Parameters

Name Type In Required Description

region

string

query

False

roleArn

string

query

False

cloudProviderAccountId

string

query

False

Error

Status: Default, Default response
Name Type Required Description

vpcId

string

True

state

string

True

cidrBlock

string

True

tags

array[VpcTagResponse]

True

default

boolean

True

subnets

array[SubnetResponse]

True

securityGroups

array[SecurityGroupResponse]

True

tenancy

string

True

Definitions

See Definitions

VpcTagResponse

Name Type Required Description

key

string

True

value

string

True

SubnetResponse

Name Type Required Description

subnetId

string

True

cidr

string

True

subnetName

string

False

availabilityZone

string

True

availableIps

integer

True

minimumRequiredIps

integer

True

outpostArn

string

False

SecurityGroupResponse

Name Type Required Description

securityGroupId

string

True

description

string

True

name

string

True