Retrieves a list of VPCs for the specified account

GET 
/v1/clouds/aws/regions/:region/vpcs

Retrieves a list of VPCs for the specified account

Request

Path Parameters

region stringrequired

Region for which VPCs are requested

Query Parameters

cloudAccountUid stringrequired

Uid for the specific AWS cloud account

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

(empty)

application/json

Schema

Schema

vpcs

object[]

required

Array [

cidrBlockstring

namestring

Name of the virtual network

subnets

undefined[]

List of subnets associated to a AWS VPC

Array [

azstring

Every subnet can only be associated with only one Availability Zone

isPrivateboolean

Is this subnet private

mapPublicIpOnLaunchboolean

Indicates whether instances launched in this subnet receive a public IPv4 address.

namestring

Name of the subnet

subnetIdstring

Id of the subnet

]

vpcIdstringrequired

Id of the virtual network

]

Example (from schema)

{
  "vpcs": [
    {
      "cidrBlock": "string",
      "name": "string",
      "subnets": [
        {
          "az": "string",
          "isPrivate": true,
          "mapPublicIpOnLaunch": true,
          "name": "string",
          "subnetId": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

Loading...