Skip to content
  • Auto
  • Light
  • Dark

List Supported Policies

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.

Returns
supported_policiesarray of object
optional
Hide ParametersShow Parameters
namestring
optional

The name of the Droplet backup plan.

possible_daysarray of string
optional

The day of the week the backup will occur.

possible_window_startsarray of number
optional

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

retention_period_daysnumber
optional

The number of days that a backup will be kept.

window_length_hoursnumber
optional

The number of hours that a backup window is open.

curl https://api.digitalocean.com//v2/droplets/backups/supported_policies \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
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
    }
  ]
}