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.droplets.list_backups(
    droplet_id=3164444,
    per_page=20,
    page=1,
)

Description

To retrieve any backups associated with a Droplet, send a GET request to /v2/droplets/{droplet_id}/backups.

You will get back a JSON object that has a backups key. This will be set to an array of backup objects, each of which contain the standard Droplet backup attributes.

Parameters

droplet_id integer required

A unique identifier for a Droplet instance.

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

Request Sample

import os
from pydo import Client

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

resp = client.droplets.list_backups(droplet_id=594828)

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.droplets.list_backups(droplet_id=3164444, )
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.droplets.list_backups(droplet_id=3164444, page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

{
  "backups": [
    {
      "id": 67539192,
      "name": "web-01- 2020-07-29",
      "distribution": "Ubuntu",
      "slug": null,
      "public": false,
      "regions": [
        "nyc3"
      ],
      "created_at": "2020-07-29T01:44:35Z",
      "min_disk_size": 50,
      "size_gigabytes": 2.34,
      "type": "backup"
    }
  ],
  "links": {},
  "meta": {
    "total": 1
  }
}

More Information

See /v2/droplets/{droplet_id}/backups in the API reference for additional detail on responses, headers, parameters, and more.