Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

List Policies

API Reference
GPU Droplets
Backups
List Backup Policies for All Existing Droplets
get/v2/droplets/backups/policies

To list information about the backup policies for all Droplets in the account, send a GET request to /v2/droplets/backups/policies.

Query ParametersExpand Collapse
page: optional number

Which 'page' of paginated results to return.

minimum1
per_page: optional number

Number of items returned per page

minimum1
maximum200
ReturnsExpand Collapse
meta: MetaProperties { total }

Information about the response itself.

total: optional number

Number of objects returned by the request.

pages: optional ForwardLinks { last, next } or BackwardLinks { first, prev } or unknown
Accepts one of the following:
UnionMember2 = unknown
policies: optional map[object { backup_enabled, backup_policy, droplet_id, next_backup_window } ]

A map where the keys are the Droplet IDs and the values are objects containing the backup policy information for each Droplet.

backup_enabled: optional boolean

A boolean value indicating whether backups are enabled for the Droplet.

backup_policy: optional DropletBackupPolicy { hour, plan, retention_period_days, 2 more }

An object specifying the backup policy for the Droplet.

hour: optional 0 or 4 or 8 or 3 more

The hour of the day that the backup window will start.

Accepts one of the following:
0
4
8
12
16
20
plan: optional "daily" or "weekly"

The backup plan used for the Droplet. The plan can be either daily or weekly.

Accepts one of the following:
"daily"
"weekly"
retention_period_days: optional number

The number of days the backup will be retained.

weekday: optional "SUN" or "MON" or "TUE" or 4 more

The day of the week on which the backup will occur.

Accepts one of the following:
"SUN"
"MON"
"TUE"
"WED"
"THU"
"FRI"
"SAT"
window_length_hours: optional number

The length of the backup window starting from hour.

droplet_id: optional number

The unique identifier for the Droplet.

next_backup_window: optional DropletNextBackupWindow { end, start }

An object containing keys with the start and end times of the window during which the backup will occur.

end: optional string

A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window.

formatdate-time
start: optional string

A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window.

formatdate-time
List Backup Policies for All Existing Droplets
  • http
  • typescript
  • python
curl https://api.digitalocean.com/v2/droplets/backups/policies \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
{
  "meta": {
    "total": 1
  },
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "policies": {
    "foo": {
      "backup_enabled": true,
      "backup_policy": {
        "hour": 0,
        "plan": "daily",
        "retention_period_days": 7,
        "weekday": "SUN",
        "window_length_hours": 4
      },
      "droplet_id": 7101383,
      "next_backup_window": {
        "end": "2019-12-04T23:00:00Z",
        "start": "2019-12-04T00:00:00Z"
      }
    }
  }
}
Returns Examples
{
  "meta": {
    "total": 1
  },
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  },
  "policies": {
    "foo": {
      "backup_enabled": true,
      "backup_policy": {
        "hour": 0,
        "plan": "daily",
        "retention_period_days": 7,
        "weekday": "SUN",
        "window_length_hours": 4
      },
      "droplet_id": 7101383,
      "next_backup_window": {
        "end": "2019-12-04T23:00:00Z",
        "start": "2019-12-04T00:00:00Z"
      }
    }
  }
}