API ReferenceCloud Vms

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_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

Snapshot restore status returned successfully.
organization_idstring
workspace_idstring
restore_idstring
source_vm_idstring
target_modeenum
recovery_point_idstring
statusenum
organization_namestring or nullOptional
workspace_namestring or nullOptional
target_vm_idstring or nullOptional
target_vm_namestring or nullOptional
recovery_point_typeenumOptional
started_atdatetime or nullOptional
completed_atdatetime or nullOptional
error_messagestring or nullOptional
metadatamap from strings to anyOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error