Skip to main content
GET
/
projects
/
{project_id}
/
vpcs
/
{vpc_id}
/
peerings
/
{peering_id}
Get a VPC Peering
curl --request GET \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "1234567890",
  "peer_account_id": "acc-12345",
  "peer_region_code": "aws-us-east-1",
  "peer_vpc_id": "1234567890",
  "provisioned_id": "1234567890",
  "status": "active",
  "error_message": "VPC not found"
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication using your Tiger Cloud public key and secret key.

Format: Authorization: Basic <base64(public_key:secret_key)>

Example:

curl -X GET "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services" \
  -H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)"

Path Parameters

​
project_id
string
required

The unique identifier of the project.

Example:

"rp1pz7uyae"

​
vpc_id
string
required

The unique identifier of the VPC.

Example:

"1234567890"

​
peering_id
string
required

The unique identifier of the VPC peering connection.

Example:

"1234567890"

Response

VPC peering details.

​
id
string
Example:

"1234567890"

​
peer_account_id
string
Example:

"acc-12345"

​
peer_region_code
string
Example:

"aws-us-east-1"

​
peer_vpc_id
string
Example:

"1234567890"

​
provisioned_id
string
Example:

"1234567890"

​
status
string
Example:

"active"

​
error_message
string
Example:

"VPC not found"