API ReferenceCloud Vms

Restore a cloud VM backup

Restores a backup recovery point by replacing a VM, creating a new VM, or restoring one volume. Requires scope: vm.write.

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

vm_idstringRequired
Virtual machine 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.

Request

This endpoint expects an object.
recovery_point_idstringRequired>=1 character
target_modeenumOptionalDefaults to replace
target_vm_namestring or nullOptional1-255 characters
target_cpuinteger or nullOptional1-256
target_ram_mbinteger or nullOptional512-2097152
target_disk_gbinteger or nullOptional10-10000
target_plan_idstring or nullOptional1-255 characters
target_plan_namestring or nullOptional1-255 characters
target_plan_codestring or nullOptional1-255 characters
target_plan_typestring or nullOptional1-128 characters
target_performance_categorystring or nullOptional1-128 characters
target_plan_monthly_ratedouble or nullOptional>=0
target_plan_hourly_ratedouble or nullOptional>=0
target_bandwidth_tbdouble or string or nullOptional
target_bandwidth_displaystring or nullOptional1-128 characters
target_network_bandwidthstring or nullOptional1-128 characters
target_compute_node_idstring or nullOptional1-255 characters
target_gpu_typestring or nullOptional1-128 characters
target_gpu_modelstring or nullOptional1-255 characters
target_gpu_countinteger or nullOptional0-16
target_gpu_memory_gbdouble or nullOptional>=0
target_gpu_memory_displaystring or nullOptional1-128 characters
target_site_idstring or nullOptional1-255 characters
target_site_namestring or nullOptional1-255 characters
selected_volume_idstring or nullOptional>=1 character
requested_bystringOptional1-128 charactersDefaults to api
auto_startbooleanOptionalDefaults to true

Response

Backup restore started 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

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error