This is an archive version of the document. To get the most up-to-date information, see the current version.(POST) /vAppRestorePoints/{ID}?action=restore
Starts the full VM restore process from the vApp restore point having the specified ID.
Request
To start the full vApp restore, you need to send the POST HTTP request to the /vAppRestorePoints/{ID}/?actions=restore URL.
HTTP Request
POST http://<Enterprise-Manager>:9399/api/vAppRestorepoints/{ID}?action=restore |
Request Headers
The request contains the following headers:
Header | Required | Description |
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Request Body
In the request body, the client must send the parameters for the full vApp restore process. The body of the request must conform to the XML Schema Definitionem_rest_ of Veeam Backup Enterprise Manager RESTful API.
The request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
PowerOnAfter | Boolean | Specifies if VMs in the vApp must be powered on after the restore process is complete. | Yes | 1/1 |
HierarchyRoot | UID | ID of the host on which the vApp must be restored, for example: urn:veeam:HierarchyRoot:2dcfebc9-eb06-4d3b-a639-c1cfa8483621. | Yes | 1/1 |
OrgVdcRef | HierarchyObj | Reference to the OrgVdc to which the vApp must be restored. The reference can be constructed manually or obtained with the lookup service. | Yes | 1/1 |
vAppNewName | String | Name of the restored vApp. If this parameter is not specified, the initial vApp name will be used. | Yes | 0/1 |
VmsRestore | vCloudVmRestoreParametersInfo | Defines VM-specific parameters. | No | — |
VM restore parameters are provided in the following format:
<VmsRestoreParameters> |
You can define the following restore parameters for VMs:
Element | Type | Description | Modifiable | Min/Max Occurrence |
VmRestorePointUid | UID | ID of the restore point from which the VM must be restored, for example: urn:veeam:VmRestorePoint:48c8cd65-d5fa-4ca6-8a98-d3fde641086e. | Yes | 1/1 |
VmNewName | String | Name of the restored VM. If this parameter is not specified, the VM is restored with its initial name. | Yes | 0/1 |
DatastoreRef | HierarchyObjRef | Reference to the datastore on which VM files must be placed. The reference can be constructed manually or obtained with the lookup service. | Yes | 0/1 |
OrgVdcStorageProfileRef | HierarchyObjRef | Reference to the OrgVdc profile to be used for the restored VM. The reference can be constructed manually or obtained with the lookup service. | Yes | 0/1 |
LinkedCloneVmTemplateRef | HierarchyObjRef | (For linked clone VMs) Reference to the template that was used to create the VM. The reference can be constructed manually or obtained with the lookup service. | Yes | 0/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
Query Parameters
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 202 Accepted.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/xml. |
Response Body
In the response body, Veeam Backup Enterprise Manager returns an ID of the task that has been created to perform the requested action, and the task state. You can check the operation results by sending the GET HTTP request to the URL of the task resource.
Additionally, Veeam Backup Enterprise Manager returns a link to the task deletion operation. You can send the GET HTTP request to the URL in the link to stop the task execution.
Example
The example below restores vApp2 from the restore point having ID f139af13-0d49-49c1-bf88-8b2d0db621e3 and registers it on the same host under a new name — vApp2_restored.
Request: POST http://localhost:9399/api/vAppRestorePoints/f139af13-0d49-49c1-bf88-8b2d0db621e3?action=restore
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 202 Accepted
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1"> |
To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:
Request: GET http://localhost:9399/api/tasks/task-1
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 Success
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1"> |