RArafftechnologies
Backup Schedules

Create backup schedule

Changed on

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

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/backup-schedules
  • Auth
    API key in header X-API-Key

Headers

X-Project-IDstring uuid required

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

Request body

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'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday'

Day of week. Required when type is weekly.

keep_countinteger required

Number of backups to retain before auto-pruning (2-100)

Example request

{
  "time": "8am"
}

Response

Backup schedule created

successboolean

Changes

  • efd3c11c5c92Revision changes
    • breaking

      the request property's min was increased to 2.00

    • warning

      the request property's max was set to 100.00

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 64c270db1c2eRevision changes
    • info

      endpoint added