post

/vms/{uuid}/restore

Restore a Virtual Machine to a snapshotted state.

If the VM is currently running, it will be powered off. Since Virtual Machine snapshots do not include the Virtual Machine memory image, the Virtual Machine will remain powered off after the restore is complete.

A Virtual Machine snapshot may no longer be compatible with the current virtual network configuration. In this case, the user may choose not to restore the Virtual Machine’s network adpaters using the restoreNetworkConfig keyword argument.

This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.

Request Parameters

1 Path Parameter

Request Body

Restore Virtual Machine

Schema
object
restore_network_configuration
boolean
snapshot_uuid
string
uuid
string
vm_logical_time_stamp
integer
1 validation

Responses

Successful operation

Schema
object
task_uuid
string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
uuid
$$.env
No $$.env variables are being used in this request.