Get a cloud VM snapshot restore
Returns the current status of a cloud VM snapshot restore. Requires scope: vm.read.
Authentication
AuthorizationBearer
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
restore_id
Snapshot or backup restore operation ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Response
Snapshot restore status returned successfully.
organization_id
ID of the organization that owns the VM.
workspace_id
ID of the workspace the VM belongs to.
restore_id
Unique ID of the restore job.
source_vm_id
VM the recovery point was taken from.
target_mode
replace: restored onto the source VM.new_vm: restored into a new VM.volume_only: a single volume was restored.
Allowed values:
recovery_point_id
Recovery point that was restored.
status
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.
organization_name
Display name of the owning organization, when the service has it.
workspace_name
Display name of the workspace, when the service has it.
target_vm_id
VM that received the restore: the source VM for replace, the new VM for new_vm.
target_vm_name
Display name of the target VM.
recovery_point_type
backup: the recovery point is a backup run.snapshot: the recovery point is a snapshot set.
Allowed values:
started_at
When the restore started (ISO 8601); null while queued.
completed_at
When the restore finished (ISO 8601); null until it does.
error_message
Error detail when status is failed.
metadata
Additional service-specific key-value data.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
