droplet_supported_backup_policies
Creates, updates, deletes, gets or lists a droplet_supported_backup_policies
resource.
Overview
Name | droplet_supported_backup_policies |
Type | Resource |
Id | digitalocean.compute.droplet_supported_backup_policies |
Fields
The following fields are returned by SELECT
queries:
- droplets_list_supported_backup_policies
A JSON object with an supported_policies
key set to an array of objects describing each supported backup policy.
Name | Datatype | Description |
---|---|---|
name | string | The name of the Droplet backup plan. (example: daily) |
possible_days | array | The day of the week the backup will occur. |
possible_window_starts | array | An array of integers representing the hours of the day that a backup can start. |
retention_period_days | integer | The number of days that a backup will be kept. |
window_length_hours | integer | The number of hours that a backup window is open. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
droplets_list_supported_backup_policies | select | To retrieve a list of all supported Droplet backup policies, send a GET request to /v2/droplets/backups/supported_policies . |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|
SELECT
examples
- droplets_list_supported_backup_policies
To retrieve a list of all supported Droplet backup policies, send a GET
request to /v2/droplets/backups/supported_policies
.
SELECT
name,
possible_days,
possible_window_starts,
retention_period_days,
window_length_hours
FROM digitalocean.compute.droplet_supported_backup_policies;