Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rafftechnologies.com/llms.txt

Use this file to discover all available pages before exploring further.

Updated May 10, 2026 The raff backup command group covers managed backups of VMs — full point-in-time copies of the VM’s disk, stored separately from the VM. Restoring overwrites the source VM’s current disk state. Schedules manage their own retention and auto-prune older backups. Every subcommand supports --output json for scripting. Alias: raff backups.

​
Subcommand index

SubcommandWhat it does
listList backups
getShow details for one backup
createTake an on-demand backup
restoreRestore a VM from a backup
deleteDelete a backup
schedule list / get / create / update / deleteManage recurring schedules

​
list

raff backup list [--vm-id <vm-uuid>] [--status pending|creating|ready|restoring|failed] [--output table|json]
List backups in the current project. The --status filter is applied client-side. Output columns: ID, NAME, SOURCE VM, SIZE, STATUS, CREATED. 
raff backup list
raff backup list --vm-id <vm-uuid>
raff backup list --status ready

​
get

raff backup get <backup-id> [--output table|json]
Show full details — source VM, size, status, expiration date.

​
create

raff backup create --vm-id <vm-uuid> [--name <custom-name>]
Take an on-demand backup of a VM. The call returns immediately with the backup record and a queued status; backups run asynchronously. Poll with raff backup get to wait for ready. If --name is omitted, the API generates a timestamped name.

​
restore

raff backup restore <backup-id> [--force]
Restore the source VM from this backup. The current disk state is overwritten. Pass --force to skip the confirmation prompt — required in scripts.

​
delete

raff backup delete <backup-id> [--force]
Delete a backup. Pass --force to skip the confirmation prompt. Backups created by a schedule are managed by the retention engine — don’t manually delete them or you’ll fight the schedule.

​
schedule list

raff backup schedule list [--output table|json]
List recurring backup schedules in the current project. Output columns: ID, NAME, SOURCE VM, FREQUENCY, KEEP, RUNTIME. Alias: raff backup schedules list.

​
schedule get

raff backup schedule get <schedule-id>

​
schedule create

raff backup schedule create \
  --vm-id <vm-uuid> \
  --frequency daily|weekly \
  --time <HH:MM-or-8am> \
  --keep <n> \
  [--day Monday..Sunday]
Create a recurring backup schedule. Required: --vm-id, --frequency. --day is required when frequency is weekly. --time defaults to 08:00; --keep defaults to 7 and controls how many backups are retained before auto-pruning. 
# Nightly, keep last 14
raff backup schedule create --vm-id <vm-uuid> \
  --frequency daily --time 03:00 --keep 14

# Weekly Saturday, keep last 4
raff backup schedule create --vm-id <vm-uuid> \
  --frequency weekly --day Saturday --time 04:00 --keep 4

​
schedule update

raff backup schedule update <schedule-id> \
  [--frequency daily|weekly] [--time <time>] [--day <day>] [--keep <n>]
Update one or more schedule fields. At least one flag must be provided.

​
schedule delete

raff backup schedule delete <schedule-id> [--force]
Delete a schedule. Existing backups it created remain in the project — delete them manually if you no longer need them.

Snapshot commands

Lighter-weight point-in-time snapshots.

raff_backup_schedule (Terraform)

Declarative recurring backups.

raff_backup (Terraform)

Declarative one-shot backups.
Last modified on May 11, 2026