Get a VPC

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

Retrieves the details of a specific VPC by its ID.

Path ParametersExpand Collapse

project_id: string

vpc_id: string

ReturnsExpand 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.

Get a VPC

curl https://console.cloud.tigerdata.com/public/api/v1/projects/$PROJECT_ID/vpcs/$VPC_ID \
    -H "Authorization: Bearer $TIGER_CLOUD_API_KEY"

{
  "id": "1234567890",
  "cidr": "10.0.0.0/16",
  "created": "2025-01-15T09:30:00Z",
  "name": "my-production-vpc",
  "region_code": "us-east-1",
  "status": "CREATED",
  "provisioned_id": "vpc-0123456789abcdef0"
}

Returns Examples

{
  "id": "1234567890",
  "cidr": "10.0.0.0/16",
  "created": "2025-01-15T09:30:00Z",
  "name": "my-production-vpc",
  "region_code": "us-east-1",
  "status": "CREATED",
  "provisioned_id": "vpc-0123456789abcdef0"
}