Give Feedback

pydo.vpc_routes.list()

Generated on 1 Oct 2026 from pydo version v0.43.0

Copy page as Markdown View page as Markdown

Usage

client.vpc_routes.list(
    vpc_uuid="997615ce-132d-4bae-9270-9ee21b395e5d",
    per_page=20,
    page=1,
)

Returns JSONRaises HttpResponseError

Description

To list the read-only VPC-scoped routes for a VPC, send a GET request to /v2/vpcs/{vpc_uuid}/routes. VPC-scoped routes cannot be created, updated, or deleted through the public API.

Parameters

vpc_uuid string required

The unique identifier of the VPC.

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.vpc_routes.list(vpc_uuid="997615ce-132d-4bae-9270-9ee21b395e5d", )
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.vpc_routes.list(vpc_uuid="997615ce-132d-4bae-9270-9ee21b395e5d", page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

Show Response Example

{
  "routes": [
    {
      "id": "f0e1d2c3-b4a5-6789-0fed-cba987654321",
      "type": "STATIC",
      "destination_cidr": "0.0.0.0/0",
      "target_urns": [
        "do:nat_gateway:14aa1d1b-e6ab-4ccb-bb10-dade56fcb8ec"
      ],
      "modifiable": false,
      "created_at": "2026-01-14T10:00:00Z"
    }
  ],
  "links": {
    "pages": {
      "next": "https://api.digitalocean.com/v2/vpcs/997615ce-132d-4bae-9270-9ee21b395e5d/routes?page=2&per_page=20"
    }
  },
  "meta": {
    "total": 1
  }
}

More Information

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