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

(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 Veeam 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 RESTful 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.

Request

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

HTTP Request

POST http://<Enterprise-Manager>:9399/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. To learn more, see Authentication and Security.

Accept

False

The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

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 RESTful API.

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:

  • Linux
  • Windows

Yes

0/1

For example:

<?xml version="1.0" encoding="utf-8"?>
<StartMountSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<OsKind>Windows</OsKind>
</StartMountSpec>

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. Possible values:

  • application/xml
  • application/json

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 guest OS files from the restore point having ID 710c0a5f-2783-4222-b669-0da996b09b97 for the exch01 VM:

Request:

POST http://localhost:9399/api/vmRestorePoints/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/710c0a5f-2783-4222-b669-0da996b09b97/mounts/1" Name="710c0a5f-2783-4222-b669-0da996b09b97@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 Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation