Retrieve Policy

API Reference

GPU Droplets

Backups

Retrieve the Backup Policy for an Existing Droplet

client.gpuDroplets.backups.retrievePolicy(numberdropletID, RequestOptionsoptions?): BackupRetrievePolicyResponse { policy }

get/v2/droplets/{droplet_id}/backups/policy

To show information about an individual Droplet's backup policy, send a GET request to /v2/droplets/$DROPLET_ID/backups/policy.

ParametersExpand Collapse

dropletID: number

ReturnsExpand Collapse

BackupRetrievePolicyResponse { policy }

policy?: Policy { backup_enabled, backup_policy, droplet_id, next_backup_window }

backup_enabled?: boolean

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

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

An object specifying the backup policy for the Droplet.

hour?: 0 | 4 | 8 | 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?: "daily" | "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?: number

The number of days the backup will be retained.

weekday?: "SUN" | "MON" | "TUE" | 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?: number

The length of the backup window starting from hour.

droplet_id?: number

The unique identifier for the Droplet.

next_backup_window?: DropletNextBackupWindow { end, start } | null

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

end?: string

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

formatdate-time

start?: string

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

formatdate-time

Retrieve the Backup Policy for an Existing Droplet

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const response = await client.gpuDroplets.backups.retrievePolicy(3164444);

console.log(response.policy);

200 example

{
  "policy": {
    "backup_enabled": true,
    "backup_policy": {
      "hour": 0,
      "plan": "daily",
      "weekday": "SUN"
    },
    "droplet_id": 7101383,
    "next_backup_window": {
      "end": "2019-12-04T23:00:00Z",
      "start": "2019-12-04T00:00:00Z"
    }
  }
}

Returns Examples

200 example

{
  "policy": {
    "backup_enabled": true,
    "backup_policy": {
      "hour": 0,
      "plan": "daily",
      "weekday": "SUN"
    },
    "droplet_id": 7101383,
    "next_backup_window": {
      "end": "2019-12-04T23:00:00Z",
      "start": "2019-12-04T00:00:00Z"
    }
  }
}