Skip to main content
POST
Create backup schedule
Updated May 8, 2026

Authorizations

X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Headers

X-Project-ID
string<uuid>
required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Body

application/json
vm_id
string<uuid>
required

Target VM UUID

type
enum<string>
required

Schedule frequency

Available options:
daily,
weekly
time
string
required

Time of day to run the backup (e.g. 8am, 13:00)

Example:

"8am"

keep_count
integer
required

Number of backups to retain before auto-pruning

Required range: x >= 1
day_of_week
enum<string>

Day of week. Required when type is weekly.

Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday

Response

Backup schedule created

success
boolean
data
object
Last modified on May 8, 2026