v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB

Backup Schedules

Create backup schedule

Create a recurring backup schedule for a VM.

Daily — set type to daily. Runs every day at time.
Weekly — set type to weekly and pass day_of_week (Monday–Sunday). Runs on that day at time.

keep_count controls retention — older backups beyond this count are pruned automatically.

post/api/v1/backup-schedules

X-Project-IDstring uuid required

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

vm_idstring uuid required

Target VM UUID

type'daily' | 'weekly' required

Schedule frequency

timestring required

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

Day of week. Required when type is weekly.

keep_countinteger required

Number of backups to retain before auto-pruning

{
  "time": "8am"
}

Backup schedule created

successboolean