Addons /
Get addon backup schedules
Required permission
Project > Addons > General > Read
Path parameters
projectId
string requiredID of the project
addonId
string requiredID of the addon
Query parameters
per_page
integerThe number of results to display per request. Maximum of 100 results per page.
page
integerThe page number to access.
cursor
stringThe cursor returned from the previous page of results, used to request the next page.
Response body
- {object}
Response object.
data
{object} requiredResult data.
schedules
[array]- {object}
id
string requiredID of the schedule.
backupType
string requiredThe type of backup being performed.
one ofdump, snapshotscheduling
{object} requiredInformation about the scheduling for the backup schedule.
interval
string requiredThe interval between backups. Each addon can only have one backup schedule of each interval for each backup type.
one ofhourly, daily, weeklyminute
[array] requiredAn array of minutes when the backup should be performed.
- integer
A minute when the backup should be performed.
min0max59 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 fordaily
andweekly
intervals and unavailable forhourly
intervals.- integer
An hour when the backup should be performed, in 24 hour format.
min0max23 day
[array]An array of days of the week when the backup should be performed, where
0
represents Monday and6
represents Sunday. On these days, a backup will be performed at each of the minutes provided in theminute
field whenever it is an hour from thehour
field. Required forweekly
intervals and unavailable forhourly
anddaily
intervals.- integer
A day of the week when the backup should be performed, where
0
represents Monday and6
represents Sunday.min0max6 retentionTime
integer requiredThe time, in days, that the backups are retained for.
createdAt
string requiredThe timestamp the backup schedule was created.
updatedAt
string requiredThe timestamp the backup schedule was last updated.
GET /v1/projects/{projectId}/addons/{addonId}/backup-schedules
Example response
200 OK
JSON
{
"data": {
"schedules": [
{
"id": "62cc20b90956ab62a58e8474",
"backupType": "snapshot",
"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"
}
]
}
}