API Reference

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Vpcs

Manage VPCs and their peering connections.

List All VPCs

client.projects.vpcs.list(stringprojectID, RequestOptionsoptions?): VpcListResponse { id, cidr, name, region_code }

GET/projects/{project_id}/vpcs

Create a VPC

client.projects.vpcs.create(stringprojectID, VpcCreateParams { cidr, name, region_code } body, RequestOptionsoptions?): Vpc { id, cidr, name, region_code }

POST/projects/{project_id}/vpcs

Get a VPC

client.projects.vpcs.retrieve(stringvpcID, VpcRetrieveParams { project_id } params, RequestOptionsoptions?): Vpc { id, cidr, name, region_code }

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

Delete a VPC

client.projects.vpcs.delete(stringvpcID, VpcDeleteParams { project_id } params, RequestOptionsoptions?): void

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

Rename a VPC

client.projects.vpcs.rename(stringvpcID, VpcRenameParams { project_id, name } params, RequestOptionsoptions?): Vpc { id, cidr, name, region_code }

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

ModelsExpand Collapse

Vpc { id, cidr, name, region_code }

id?: string

cidr?: string

name?: string

region_code?: string

VpcListResponse = Array<Vpc { id, cidr, name, region_code } >

id?: string

cidr?: string

name?: string

region_code?: string

VpcsPeerings

Manage VPCs and their peering connections.

List VPC Peerings

client.projects.vpcs.peerings.list(stringvpcID, PeeringListParams { project_id } params, RequestOptionsoptions?): PeeringListResponse { id, error_message, peer_account_id, 4 more }

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

Create a VPC Peering

client.projects.vpcs.peerings.create(stringvpcID, PeeringCreateParams { project_id, peer_account_id, peer_region_code, peer_vpc_id } params, RequestOptionsoptions?): Peering { id, error_message, peer_account_id, 4 more }

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

Get a VPC Peering

client.projects.vpcs.peerings.retrieve(stringpeeringID, PeeringRetrieveParams { project_id, vpc_id } params, RequestOptionsoptions?): Peering { id, error_message, peer_account_id, 4 more }

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

Delete a VPC Peering

client.projects.vpcs.peerings.delete(stringpeeringID, PeeringDeleteParams { project_id, vpc_id } params, RequestOptionsoptions?): void

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

ModelsExpand Collapse

Peering { id, error_message, peer_account_id, 4 more }

id?: string

error_message?: string

peer_account_id?: string

peer_region_code?: string

peer_vpc_id?: string

provisioned_id?: string

status?: string

PeeringListResponse = Array<Peering { id, error_message, peer_account_id, 4 more } >

id?: string

error_message?: string

peer_account_id?: string

peer_region_code?: string

peer_vpc_id?: string

provisioned_id?: string

status?: string