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, created, 4 more }

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

created: string

Creation timestamp.

formatdate-time

name: string

The name of the VPC.

region_code: string

The cloud region where the VPC is hosted.

status: "CREATING" or "CREATED" or "DELETING" or 3 more

The current status of the VPC:

CREATING: the VPC is being provisioned
CREATED: the VPC is provisioned and ready
DELETING: the VPC is being deleted
DELETED: the VPC has been deleted
ERROR: the VPC is in an error state
UNKNOWN: an unrecognized state

One of the following:

"CREATING"

"CREATED"

"DELETING"

"DELETED"

"ERROR"

"UNKNOWN"

provisioned_id: optional string

The provider-assigned identifier for the provisioned VPC. Absent until provisioning completes.

VpcListResponse = array of Vpc { id, cidr, created, 4 more }

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

created: string

Creation timestamp.

formatdate-time

name: string

The name of the VPC.

region_code: string

The cloud region where the VPC is hosted.

status: "CREATING" or "CREATED" or "DELETING" or 3 more

The current status of the VPC:

CREATING: the VPC is being provisioned
CREATED: the VPC is provisioned and ready
DELETING: the VPC is being deleted
DELETED: the VPC has been deleted
ERROR: the VPC is in an error state
UNKNOWN: an unrecognized state

One of the following:

"CREATING"

"CREATED"

"DELETING"

"DELETED"

"ERROR"

"UNKNOWN"

provisioned_id: optional string

The provider-assigned identifier for the provisioned VPC. Absent until provisioning completes.

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, 5 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.

status: "PENDING" or "TIMEOUT" or "APPROVED" or 5 more

The current status of a VPC peering connection:

PENDING: the peering request has been made and is awaiting action
TIMEOUT: the peering request timed out before being resolved
APPROVED: the peering request has been approved
ACTIVE: the peering connection is active
DISABLED: the peering connection has been disabled
DELETING: the peering connection is being deleted
INVALID: the peering request is invalid
UNKNOWN: an unrecognized state

One of the following:

"PENDING"

"TIMEOUT"

"APPROVED"

"ACTIVE"

"DISABLED"

"DELETING"

"INVALID"

"UNKNOWN"

created: optional string

Creation timestamp.

formatdate-time

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.

PeeringListResponse = array of Peering { id, peer_account_id, peer_region_code, 5 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.

status: "PENDING" or "TIMEOUT" or "APPROVED" or 5 more

The current status of a VPC peering connection:

PENDING: the peering request has been made and is awaiting action
TIMEOUT: the peering request timed out before being resolved
APPROVED: the peering request has been approved
ACTIVE: the peering connection is active
DISABLED: the peering connection has been disabled
DELETING: the peering connection is being deleted
INVALID: the peering request is invalid
UNKNOWN: an unrecognized state

One of the following:

"PENDING"

"TIMEOUT"

"APPROVED"

"ACTIVE"

"DISABLED"

"DELETING"

"INVALID"

"UNKNOWN"

created: optional string

Creation timestamp.

formatdate-time

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.