This is an archive version of the document. To get the most up-to-date information, see the current version.(POST) /catalog/vms/{vmname}/vmRestorePoints/{ID}?action=browse
Starts the guest OS file restore process of the VM from the specified restore point. The VM disks are mounted to the Veeam backup server and VM guest OS files become available for restore.
Request
To start the VM guest OS restore process, you need to send the POST HTTP request to the /catalog/vms/{vmname}/vmRestorePoints/{ID}?action=browse URL.
HTTP Request
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
None.
Query Parameters
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 Success.
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.
The response body also contains a link to the VM file system that allows you to browse for VM guest OS files.
Example
The example below starts the guest OS files restore process for the srv04 VM from the restore point having ID 7caf66d5-f700-442c-9aa9-8867f031377f:
Request: POST http://localhost:9399/api/catalog/vms/srv04/vmRestorePoints/7caf66d5-f700-442c-9aa9-8867f031377f?action=browse
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"> |
