Create backup schedule
Schedules
Create Backup Schedule
Create a recurring backup schedule for a VM.
- Daily — set
typetodaily. Runs every day attime. - Weekly — set
typetoweeklyand passday_of_week(Monday–Sunday). Runs on that day attime.
keep_count controls retention — older backups beyond this count are pruned automatically.
POST
Create backup schedule
Updated May 8, 2026
Authorizations
API key for authentication. Each key is bound to a specific account.
Headers
Project ID. Required for all mutating operations (create, delete, power actions, resize).
Body
application/json
Target VM UUID
Schedule frequency
Available options:
daily, weekly Time of day to run the backup (e.g. 8am, 13:00)
Example:
"8am"
Number of backups to retain before auto-pruning
Required range:
x >= 1Day of week. Required when type is weekly.
Available options:
Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday Last modified on May 8, 2026