post /vms/{vmId}/operations/return

Return From Cloud (returnFromCloud)

When a VM is moved to run in cloud a base snapshot is taken. When the VM is moved to run back on-premises, different behaviors will take place, depending on the storage policy used for that VM. Write Isolation - When using write isolation policy, the VM is moved back on-premises to the same point in time captured in the base snapshot. To maintain state alignment across related VMs when they use the write isolation policy, all related VMs should be moved back together. Write Back - When running in cloud using the write back policy, and as long as new or changed data is available, a new snapshot (consistency checkpoint) is taken and saved on-premises on every write back cycle (1 hour or 5GB changes, whatever comes first). When you choose to run such a VM on-premises, the remaining data changes are written back and the VM is then moved back on-premises. When the move back is complete, all interim snapshots taken by Velostrata are deleted and the virtual disks are consolidated. Forced move back - If there is a sustained cloud outage you may choose to force the VM to run on-premises. For VMs that use the Write Back policy, this moves the VM back to on-premises using its latest consistency checkpoint. This will result in data loss up to the last stored checkpoint. Note - As a safety measure, the base snapshot of a VM that runs in cloud using the Write Back policy is not deleted automatically, when the Force option is used. The base snapshot can be deleted manually when verified to be no longer needed.

Path parameters

vmId (required)

Path Parameter — Virtual machine ID


This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

force (optional)

Query Parameter — Force

Return type


value (optional)

String Entity ID


String Task ID




Example data

Content-Type: application/json


This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json



Created TaskId


Error ErrorInfo

errorCode (optional)




message (optional)