Project / Volumes /

Create volume backup schedule

Create a new snapshot backup schedule for a volume.

Required permission

Project > Volumes > Backups > Create

Path parameters

projectId
string required
ID of the project
volumeId
string required
ID of the volume

Request body

{object}

scheduling
{object} required
Schedule for the backup.

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 the backup is retained for, in days.
min
1

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
ID of the schedule.

API

CLI

JS Client

POST /v1/projects/{projectId}/volumes/{volumeId}/backup-schedules

POST /v1/teams/{teamId}/projects/{projectId}/volumes/{volumeId}/backup-schedules

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"scheduling":{"interval":"weekly","minute":[30],"hour":[18],"day":[4]},"retentionTime":7}' \
  https://api.northflank.com/v1/projects/{projectId}/volumes/{volumeId}/backup-schedules

Example response

200 OK

Details about the created backup schedule.

JSON

{
  "data": {
    "id": "62cc20b90956ab62a58e8474"
  }
}