Skip to navigation
API ReferenceCloud VMs

Cancel a queued cloud VM backup restore

Cancels a restore only while it is queued and has not started. A running restore is refused with 409. Repeating a successful cancellation returns the cancelled restore. Requires scope: vm.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# RESTORE_ID: Snapshot or backup restore operation ID
curl -X POST "https://api.ibee.ai/v1/compute/cloud-vm-backups/restores/$RESTORE_ID/actions/cancel?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN"

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_idstringRequired>=1 character
Snapshot or backup restore operation ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Restore cancelled before execution.
organization_idstring
ID of the organization that owns the VM.
workspace_idstring
ID of the workspace the VM belongs to.
restore_idstring
Unique ID of the restore job.
source_vm_idstring
VM the recovery point was taken from.
target_modeenum
  • replace: restored onto the source VM.
  • new_vm: restored into a new VM.
  • volume_only: a single volume was restored.
Allowed values:
recovery_point_idstring
Recovery point that was restored.
statusenum

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 (see error_message).
  • cancelled: stopped before it completed.
  • deleting: remote backup deletion is in progress; the run becomes unavailable after cleanup.
organization_namestring or nullOptional
Display name of the owning organization, when the service has it.
workspace_namestring or nullOptional
Display name of the workspace, when the service has it.
target_vm_idstring or nullOptional

VM that received the restore: the source VM for replace, the new VM for new_vm.

target_vm_namestring or nullOptional
Display name of the target VM.
recovery_point_typeenumOptional
  • backup: the recovery point is a backup run.
  • snapshot: the recovery point is a snapshot set.
Allowed values:
started_atdatetime or nullOptional

When the restore started (ISO 8601); null while queued.

completed_atdatetime or nullOptional

When the restore finished (ISO 8601); null until it does.

error_messagestring or nullOptional

Error detail when status is failed.

metadatamap from strings to anyOptional

Additional service-specific key-value data.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error