Addons /

Get addon backup schedules

Gets details about an addon's backup schedules

Required permission

Project > Addons > General > Read

Path parameters

projectId
string required
ID of the project
addonId
string required
ID of the addon

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

schedules
[array]

{object}

id
string required
ID of the schedule.
backupType
string required
The type of backup being performed.
one of
dump, snapshot
backupCompressionType
string
The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`.
one of
gz, zstd
additionalDestinations
[array]
List of destinations for which a backup should be created of this backup. Only applicable for snapshot backups.

{object}

destinationId
string required
Additional custom back up destination that should be used to store the snapshot.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
retentionTime
integer
Retention time of the additional back up in days.
min
1
max
120
type
string required
The type of backup destination to use
one of
custom

customDestinationId
string
Custom backup destination in which the dump back up should be stored.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
scheduling
{object} required
Information about the scheduling for the backup schedule.

interval
string required
The interval between backups. Each addon can only have one backup schedule of each interval for each backup type.
one of
hourly, daily, weekly
minute
[array] required
An array of minutes when the backup should be performed.

integer
A minute when the backup should be performed.
min
0
max
59

hour
[array]
An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals.

integer
An hour when the backup should be performed, in 24 hour format.
min
0
max
23

day
[array]
An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals.

integer
A day of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday.
min
0
max
6

retentionTime
integer required
The time, in days, that the backups are retained for.
createdAt
string required
The timestamp the backup schedule was created.
updatedAt
string required
The timestamp the backup schedule was last updated.

API

CLI

JS Client

GET /v1/projects/{projectId}/addons/{addonId}/backup-schedules

Example response

200 OK

Details about the given addon's backup schedules.

JSON

{
  "data": {
    "schedules": [
      {
        "id": "62cc20b90956ab62a58e8474",
        "backupType": "snapshot",
        "backupCompressionType": "gz",
        "additionalDestinations": [
          {
            "destinationId": "example-backup-destination",
            "type": "custom"
          }
        ],
        "customDestinationId": "example-backup-destination",
        "scheduling": {
          "interval": "weekly",
          "minute": [
            30
          ],
          "hour": [
            18
          ],
          "day": [
            4
          ]
        },
        "retentionTime": 7,
        "createdAt": "2022-07-11T13:08:09.626Z",
        "updatedAt": "2022-07-11T13:08:09.626Z"
      }
    ]
  }
}