Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(POST) /vmReplicaPoints/{ID}/mounts

Starts the VM guest OS files restore from the specified VM replica restore point. Disks of the restored VM are mounted to the Veeam backup server and the VM guest OS files become available in the C:\VeeamFLR\<vm-name> folder.

Request

To start VM guest OS files restore, you need to send the POST HTTP request to the /vmReplicaPoints/{ID}/mounts URL.

HTTP Request

POST http://<Enterprise-Manager>:9399/api/vmReplicaPoints/{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. 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 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 VM replica guest OS files from the restore point having ID 7b8f9c7d-4e73-429a-9fc6-1ad2c58902bc:

Request:

POST http://localhost:9399/api/vmReplicaPoints/710c0a5f-2783-4222-b669-0da996b09b97/mounts

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>MountRestorePoint</Operation>
</Task>

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">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
   <Link Rel="Related" Type="VmRestorePointMount" Href="http://localhost:9399/api/vmRestorePoints/623cbbec-c8ff-4cf4-96be-d433f3b775c7/mounts/1" Name="623cbbec-c8ff-4cf4-96be-d433f3b775c7@1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>MountRestorePoint</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation