For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.vpcs.list_peerings(
    vpc_id="4de7ac8b-495b-4884-9a69-1050c6793cd6",
    per_page=20,
    page=1,
)

Description

To list all of a VPC’s peerings, send a GET request to /v2/vpcs/{vpc_id}/peerings.

Parameters

vpc_id string required

A unique identifier for a VPC.

Min: 1

per_page integer optional

Number of items returned per page

Min: 1

Max: 200

Default: 20

page integer optional

Which 'page' of paginated results to return.

Min: 1

Default: 1

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page parameter:

from urllib.parse import urlparse, parse_qs

resp = client.vpcs.list_peerings(vpc_id="4de7ac8b-495b-4884-9a69-1050c6793cd6", )
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.vpcs.list_peerings(vpc_id="4de7ac8b-495b-4884-9a69-1050c6793cd6", page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

{
  "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
  }
}

More Information

See /v2/vpcs/{vpc_id}/peerings in the API reference for additional detail on responses, headers, parameters, and more.