Sign in
DigitalOcean-public.v2-new_Droplets

List Backups for a Droplet

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.

get/v2/droplets/{droplet_id}/backups

Path parameters

droplet_idinteger required

A unique identifier for a Droplet instance.

Query parameters

per_pageinteger

Number of items returned per page

pageinteger

Which 'page' of paginated results to return.

Response

A JSON object with an backups key.

Example response

{
  "backups": [
    {
      "id": 6372321,
      "name": "web-01-1595954862243",
      "created_at": "2020-07-28T16:47:44Z",
      "regions": [
        "nyc3",
        "sfo3"
      ],
      "min_disk_size": 25,
      "size_gigabytes": 2.34,
      "type": "snapshot"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "meta": {
    "total": 1
  }
}

Changes

Changed in 4 of the 8 revisions of this API.14