Give Feedback

pydo.volume_snapshots.list()

Generated on 8 May 2026 from pydo version v0.34.0

Copy page as Markdown View page as Markdown

Usage

client.volume_snapshots.list(
    volume_id="7724db7c-e098-11e5-b522-000f53304e51",
    per_page=20,
    page=1,
)

Returns JSONRaises HttpResponseError

Description

To retrieve the snapshots that have been created from a volume, send a GET request to /v2/volumes/{volume_id}/snapshots.

Parameters

volume_id string required

The ID of the block storage volume.

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

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "name": "big-data-snapshot1475261774"
}

resp = client.volume_snapshots.list(snapshot_id="da3aa3a")

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.volume_snapshots.list(volume_id="7724db7c-e098-11e5-b522-000f53304e51", )
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.volume_snapshots.list(volume_id="7724db7c-e098-11e5-b522-000f53304e51", page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

Show Response Example

{
  "snapshots": [
    {
      "id": "8eb4d51a-873f-11e6-96bf-000f53315a41",
      "name": "big-data-snapshot1475261752",
      "regions": [
        "nyc1"
      ],
      "created_at": "2020-09-30T18:56:12Z",
      "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41",
      "resource_type": "volume",
      "min_disk_size": 10,
      "size_gigabytes": 0,
      "tags": null
    }
  ],
  "links": {},
  "meta": {
    "total": 1
  }
}

More Information

See /v2/volumes/{volume_id}/snapshots in the API reference for additional detail on responses, headers, parameters, and more.