Rename a VPC

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

Updates the name of a specific VPC.

Path ParametersExpand Collapse

project_id: string

vpc_id: string

Body ParametersJSONExpand Collapse

name: string

The new name for the VPC.

ReturnsExpand Collapse

Vpc object { id, cidr, name, region_code }

A virtual private cloud that services can be attached to.

id: optional string

The unique identifier for the VPC.

cidr: optional string

The CIDR block for the VPC.

name: optional string

The name of the VPC.

region_code: optional string

The cloud region where the VPC is hosted.

Rename a VPC

curl https://console.cloud.tigerdata.com/public/api/v1/projects/$PROJECT_ID/vpcs/$VPC_ID/rename \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \
    -d '{
          "name": "my-renamed-vpc"
        }'

{
  "id": "1234567890",
  "cidr": "10.0.0.0/16",
  "name": "my-production-vpc",
  "region_code": "us-east-1"
}

Returns Examples

{
  "id": "1234567890",
  "cidr": "10.0.0.0/16",
  "name": "my-production-vpc",
  "region_code": "us-east-1"
}