Restore a GPU VM backup
Restores a GPU VM backup recovery point by replacing the VM, creating a new GPU VM, or restoring a single volume. Asynchronous: the response carries restore_id; poll the restore status read until status is succeeded, failed or cancelled. If your client times out, read the status; never resubmit. Requires scope: vm.write.
Authentication
IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.
Path parameters
Query parameters
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
Recovery point to restore: the recovery_point_id of a succeeded backup run.
Where to restore.
replace: onto the source VM, replacing its current disks (default).new_vm: into a new VM described by thetarget_*fields.volume_only: only the volume named inselected_volume_id.
Name for the new VM (new_vm mode).
vCPUs for the new VM (1-256).
RAM for the new VM in MB (512-2097152).
Root disk for the new VM in GB (10-10000).
Compute plan for the new VM, from GET /compute/plans.
GPU model for a new GPU VM, for example A100.
Number of GPUs for a new GPU VM (0-16).
Site for the new VM, from GET /compute/sites.
Volume to restore in volume_only mode.
Response
replace: restored onto the source VM.new_vm: restored into a new VM.volume_only: a single volume was restored.
Lifecycle status of a backup run, snapshot set or restore.
queued: accepted and waiting to start.running: in progress.succeeded: finished; the recovery point is usable.failed: stopped with an error (seeerror_message).cancelled: stopped before it completed.deleting: remote backup deletion is in progress; the run becomes unavailable after cleanup.
VM that received the restore: the source VM for replace, the new VM for new_vm.
backup: the recovery point is a backup run.snapshot: the recovery point is a snapshot set.
When the restore started (ISO 8601); null while queued.
When the restore finished (ISO 8601); null until it does.
Error detail when status is failed.
Additional service-specific key-value data.
