v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_VPCs

List the Peerings of a VPC

To list all of a VPC's peerings, send a GET request to /v2/vpcs/$VPC_ID/peerings.

get/v2/vpcs/{vpc_id}/peerings

Path parameters

vpc_idstring uuid required

A unique identifier for a VPC.

Query parameters

per_pageinteger

Number of items returned per page

pageinteger

Which 'page' of paginated results to return.

Response

The response will be a JSON object with a key called peerings. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering.

Example response

{
  "peerings": [
    {
      "id": "6b5c619c-359c-44ca-87e2-47e98170c01d",
      "name": "example-vpc-peering",
      "vpc_ids": [
        "997615ce-132d-4bae-9270-9ee21b395e5d",
        "e51aed59-3bb1-4a6a-8de0-9d1329e9c997"
      ],
      "created_at": "2024-01-09T20:44:32Z",
      "status": "ACTIVE"
    },
    {
      "id": "c212b274-911c-44cc-a117-23b7da4a2922",
      "name": "another-vpc-peering",
      "vpc_ids": [
        "5a100736-b085-4f69-81fd-feee325784bb",
        "c140286f-e6ce-4131-8b7b-df4590ce8d6a"
      ],
      "created_at": "2024-01-10T13:29:58Z",
      "status": "ACTIVE"
    }
  ],
  "links": {},
  "meta": {
    "total": 2
  }
}