List

List Backups for a Droplet

get/v2/droplets/{droplet_id}/backups

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.

Path Parameters

droplet_idnumber

minimum1

Query Parameters

pagenumber

optional

Which 'page' of paginated results to return.

minimum1

per_pagenumber

optional

Number of items returned per page

minimum1

maximum200

Returns

metatotalnumberMetaProperties

Information about the response itself.

backupsarray of object

optional

Hide ParametersShow Parameters

idnumber

The unique identifier for the snapshot or backup.

created_atstring

A time value given in ISO8601 combined date and time format that represents when the snapshot was created.

formatdate-time

min_disk_sizenumber

The minimum size in GB required for a volume or Droplet to use this snapshot.

namestring

A human-readable name for the snapshot.

regionsarray of string

An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values.

size_gigabytesnumber

The billable size of the snapshot in gigabytes.

formatfloat

typeenum

"snapshot" OR "backup"

Describes the kind of image. It may be one of snapshot or backup. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup.

Hide ParametersShow Parameters

"snapshot"

"backup"

linkspagesunionPageLinks

optional

HTTPPython

curl https://api.digitalocean.com//v2/droplets/$DROPLET_ID/backups \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"

200 Example

{
  "meta": {
    "total": 1
  },
  "backups": [
    {
      "id": 6372321,
      "created_at": "2020-07-28T16:47:44Z",
      "min_disk_size": 25,
      "name": "web-01-1595954862243",
      "regions": [
        "nyc3",
        "sfo3"
      ],
      "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"
    }
  }
}