List Supported Policies

API Reference

GPU Droplets

Backups

List Supported Droplet Backup Policies

get/v2/droplets/backups/supported_policies

To retrieve a list of all supported Droplet backup policies, send a GET request to /v2/droplets/backups/supported_policies.

ReturnsExpand Collapse

supported_policies: optional array of object { name, possible_days, possible_window_starts, 2 more }

name: optional string

The name of the Droplet backup plan.

possible_days: optional array of string

The day of the week the backup will occur.

possible_window_starts: optional array of number

An array of integers representing the hours of the day that a backup can start.

retention_period_days: optional number

The number of days that a backup will be kept.

window_length_hours: optional number

The number of hours that a backup window is open.

HTTPPython

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

200 example

{
  "supported_policies": [
    {
      "name": "daily",
      "possible_days": [
        "SUN",
        "MON",
        "TUE",
        "WED",
        "THU",
        "FRI",
        "SAT"
      ],
      "possible_window_starts": [
        0,
        4,
        8,
        12,
        16,
        20
      ],
      "retention_period_days": 7,
      "window_length_hours": 4
    }
  ]
}

Returns Examples

200 example

{
  "supported_policies": [
    {
      "name": "daily",
      "possible_days": [
        "SUN",
        "MON",
        "TUE",
        "WED",
        "THU",
        "FRI",
        "SAT"
      ],
      "possible_window_starts": [
        0,
        4,
        8,
        12,
        16,
        20
      ],
      "retention_period_days": 7,
      "window_length_hours": 4
    }
  ]
}