POST /vmRestorePoints/{ID}/mounts
Starts the VM guest OS files restore from the specified restore point. Disks of the restored VM are mounted to the backup server and the VM guest OS files become available under the C:\VeeamFLR\<vm-name> folder.
Veeam Backup & Replication detects guest OS on the mounted backup automatically. With Veeam Backup Enterprise Manager REST API you can define the type of the guest OS manually. If you do not define the type of the guest OS manually, Veeam Backup Enterprise Manager will use the default value. The default value for the guest OS is Windows.
Supported Platforms
The request is supported for the following platforms:
- VMware vSphere
- VMware Cloud Director
- Microsoft Hyper-V
Request
To start the VM guest OS files restore, send the POST HTTP request to the /vmRestorePoints/{ID}/mounts URL.
HTTP Request
POST https://<Enterprise-Manager>:9398/api/vmRestorePoints/{ID}/mounts |
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. For details, see Authentication and Security. |
Content-Type | True | Identifies the format of the request body message. Possible values:
|
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
In the request body, the client can send the parameters for the mounted backup. The body of the request must conform to the XML Schema Definitionem_rest_ of Veeam Backup Enterprise Manager REST API.
Important |
If you use the XML media type, make sure that the order of parameters in the request body is correct. For details, see request body examples in this section. |
The request body must contain the elements you want to specify. You can define the following general parameters for the mount:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
OsKind | String | Specifies the guest OS:
| Yes | 0/1 |
For example:
XML Representation
<?xml version="1.0" encoding="utf-8"?> |
JSON Representation
{ "OsKind": "Windows" } |
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. Possible values:
|
Response Body
In the response body, the REST API returns a task that has been created to perform the requested operation. To track the status of the operation, send the GET /tasks/{ID} request.
The task resource also contains a link to the task deletion operation. To stop the task execution, send the DELETE /task/{ID} request to the URL in the link.
Example
The example below restores VM guest OS files from the restore point having ID 710c0a5f-2783-4222-b669-0da996b09b97 for the exch01 VM:
Request: POST https://localhost:9398/api/vmRestorePoints/710c0a5f-2783-4222-b669-0da996b09b97/mounts
Request Headers: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 202 Accepted
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track the status of the operation, send the GET HTTP request to the URL of the received task resource:
Request: GET https://localhost:9398/api/tasks/task-1
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |