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

(POST) /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore

Restores a VM guest OS file or folder. The file or folder can be restored to its original location on the VM or can be downloaded to the local machine.

For file-level restore to the original location, you can use restore points created by a backup job with enabled guest processing settings. In this case, file-level restore will be performed using the guest OS credentials that are specified in the backup job settings.

Alternatively, if guest processing settings are not enabled for the job, you can specify the guest OS credentials in the body of the request. To learn more, see File-Level Restore Options.

Request

To restore a VM guest OS file or folder, you need to send the POST HTTP request to the /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore URL.

HTTP Request

POST http://<Enterprise-Manager>:9399/api/vmRestorePoints/{ID}/mounts/{ID}/{filepath}?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 restore process. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager RESTful API.

The request body must contain either of the following elements:

Element

Type

Description

Modifiable

Min/Max Occurrence

ToOriginalLocation

FileRestoreToOriginalSpecInfoType

Use this element if you want to restore the file to the original location. To learn more, see File-Level Restore Options.

No

ForDirectDownload

Use this element if you want to download the restored file.

No

For example:

<?xml version="1.0" encoding="utf-8"?>
<FileRestoreSpec 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">
 <ForDirectDownload/>
</FileRestoreSpec>

File-Level Restore Options

Options for file-level restore to the original location are provided in the following format:

<?xml version="1.0" encoding="utf-8"?>
<FileRestoreSpec 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">
 <ToOriginalLocation Overwrite="false">
   <GuestCredentials>
     <UserName>fileserver01\administrator</UserName>
     <Password>P@ssw0rd</Password>
   </GuestCredentials>
 </ToOriginalLocation>
</FileRestoreSpec>

You can define the following options for file-level restore to the original location:

Element

Type

Description

Modifiable

Min/Max Occurrence

Overwrite

Boolean

Defines if the file or folder restored from the backup should overwrite the original file or folder. Possible values:

  • True — the file from VM backup (being restored) should replace the file on target.
  • False — both files should be kept on target.

Yes

0/1

GuestCredentials

PlainCredentialsType

Guest OS credentials for starting the file-level restore process. To learn more, see Guest OS Credentials Options.

Yes

0/1

Guest Credentials Options

Guest OS credentials for starting the file-level restore process are provided in the following format:

<GuestCredentials>
 <UserName>fileserver01\administrator</UserName>
 <Password>P@ssw0rd</Password>
</GuestCredentials>

You must define the following parameters for the guest OS credentials:

Element

Type

Description

Modifiable

Min/Max Occurrence

Username

String

User name of the guest OS account specified in the DOMAIN\USENAME format.

Yes

1/1

Password

String

Password for the guest OS account.

Yes

1/1

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.

(POST) /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore Note:

If you have selected to download a restored file or folder, the response body of the task resource will also contain links to files that can be downloaded and saved.

Example

The example below lets the client restore the E:\Documentation 2014\Offers.docx file from the VM guest OS and download it after restore:

Request:

POST http://localhost:9399/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Offers.docx?action=restore

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<FileRestoreSpec 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">
 <ForDirectDownload/>
</FileRestoreSpec>

 

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>FileRestoreFromMountPoint</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-22" />
   <Link Rel="Download" Href="http://localhost:9399/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/e:/documentation%2014/offers.docx?action=download" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>FileRestoreFromMountPoint</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

To download the restored file, find the necessary link component in the resource representation of the task and send the GET HTTP request to the http://<Enterprise-Manager>:9399/api/vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=download URL. The file will be downloaded to the default downloads folder on the Veeam backup server.

Request:

GET http://localhost:9399/api/vmRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/e:/documentation%2014/offers.docx?action=download

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

None

 

(POST) /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore Note:

If you work with Veeam Backup Enterprise Manager RESTful API using a web application as a client (for example, Veeam Backup Enterprise Manager Web Client), a web browser may propose to select whether to open the file, download it to the default downloads folder or download it to the specified folder.

 

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