Skip to main content
PUT
Update the backup schedule

Authorizations

Authorization
string
header
required

Your API key as it is, without Bearer. API access is off for new accounts: until it is turned on under Settings > API, every request answers 403 with API access is turned off for this account. Turn it on under Settings > API. If the account lists allowed IPs, a request from any other address answers 403 with This API key is not allowed from <address>.

Path Parameters

server
string
required

Body

application/json
frequency
enum<string>
required
Available options:
daily,
weekly
hour
integer
required

The hour the backup starts, in UTC.

Required range: 0 <= x <= 23
Example:

3

retention
integer
required

How many backups to keep, at most the server's slots (slots.total). Once a new backup has completed, the oldest beyond this number are deleted.

Required range: x >= 1
Example:

3

weekday
integer

Required for weekly, 0 = Sunday to 6 = Saturday. Ignored for daily.

Required range: 0 <= x <= 6
Example:

0

Response

The schedule was saved.

Whether a server's backups are enabled, its slots and its schedule.

enabled
boolean
required

Whether backups are enabled for the server.

Example:

true

slots
object
required
status
boolean
Example:

true

message
string
Example:

"Backup schedule updated."

schedule
object | null

When the server is backed up, or null while backups are disabled.