Vpcs

Manage VPCs and their peering connections.

List All VPCs

GET/projects/{project_id}/vpcs

Create a VPC

POST/projects/{project_id}/vpcs

Get a VPC

GET/projects/{project_id}/vpcs/{vpc_id}

Delete a VPC

DELETE/projects/{project_id}/vpcs/{vpc_id}

Rename a VPC

POST/projects/{project_id}/vpcs/{vpc_id}/rename

ModelsExpand Collapse

Vpc object { id, cidr, name, region_code }

A virtual private cloud that services can be attached to.

id: string

The unique identifier for the VPC.

cidr: string

The IPv4 CIDR block for the VPC, in address/prefix notation (e.g. 10.0.0.0/16).

formatcidr

name: string

The name of the VPC.

region_code: string

The cloud region where the VPC is hosted.

VpcListResponse = array of Vpc { id, cidr, name, region_code }

id: string

The unique identifier for the VPC.

cidr: string

The IPv4 CIDR block for the VPC, in address/prefix notation (e.g. 10.0.0.0/16).

formatcidr

name: string

The name of the VPC.

region_code: string

The cloud region where the VPC is hosted.

VpcRenameResponse object { message }

message: optional string

VpcsPeerings

Manage VPCs and their peering connections.

List VPC Peerings

GET/projects/{project_id}/vpcs/{vpc_id}/peerings

Create a VPC Peering

POST/projects/{project_id}/vpcs/{vpc_id}/peerings

Get a VPC Peering

GET/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id}

Delete a VPC Peering

DELETE/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id}

ModelsExpand Collapse

Peering object { id, peer_account_id, peer_region_code, 4 more }

A VPC peering connection to an external cloud account.

id: string

The unique identifier for the peering connection.

peer_account_id: string

The cloud account ID of the peer VPC.

peer_region_code: string

The cloud region of the peer VPC.

peer_vpc_id: string

The ID of the peer VPC.

error_message: optional string

A human-readable error message when the peering connection failed.

provisioned_id: optional string

The provider-assigned identifier for the provisioned peering.

status: optional string

The current status of the peering connection.

PeeringListResponse = array of Peering { id, peer_account_id, peer_region_code, 4 more }

id: string

The unique identifier for the peering connection.

peer_account_id: string

The cloud account ID of the peer VPC.

peer_region_code: string

The cloud region of the peer VPC.

peer_vpc_id: string

The ID of the peer VPC.

error_message: optional string

A human-readable error message when the peering connection failed.

provisioned_id: optional string

The provider-assigned identifier for the provisioned peering.

status: optional string

The current status of the peering connection.