POST /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore
Restores a guest OS file or folder. The file or folder can be restored to its original location on the machine 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. For details, see File-Level Restore Options.
Note |
If you work with Veeam Backup Enterprise Manager REST 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. |
Request
To restore a guest OS file or folder, send the POST HTTP request to the /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore URL.
HTTP Request
POST https://<Enterprise-Manager>:9398/api/agents/agentRestorePoints/{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. 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 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 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 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. For details, see File-Level Restore Options. | No | — |
ForDirectDownload | — | Use this element if you want to download the restored file. | No | — |
For example:
XML Representation
<?xml version="1.0" encoding="utf-8"?> |
JSON Representation
{ "ForDirectDownload": {} } |
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:
The default value is False. | Yes | 0/1 |
PermissionsOnly | Boolean | Defines whether to restore only permissions of the file or folder. The file or folder must exist on the target machine. The feature is supported for Windows machines only. Possible values:
The default value is False. | Yes | 0/1 |
GuestCredentials | PlainCredentialsType | Guest OS credentials for starting the file-level restore process. For details, see Guest OS Credentials Options. | Yes | 0/1 |
Options for file-level restore to the original location are provided in the following format:
XML Representation
<?xml version="1.0" encoding="utf-8"?> |
JSON Representation
{ "ToOriginalLocation": { "GuestCredentials": { "UserName": "fileserver01\\administrator", "Password": "P@ssw0rd" }, "Overwrite": false } } |
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 |
Guest OS credentials for starting the file-level restore process are provided in the following format:
XML Representation
<GuestCredentials> |
JSON Representation
"GuestCredentials": { "UserName": "fileserver01\\administrator", "Password": "P@ssw0rd" } |
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.
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 guest OS and download it after restore:
Request: POST https://localhost:9398/api/agents/agentRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/E:/Documentation%202014/Offers.docx?action=restore
Request Headers: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
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"> |
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 https://<Enterprise-Manager>:9398/api/agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}?action=download URL. The file will be downloaded to the default downloads folder on the backup server.
Request: GET https://localhost:9398/api/agents/agentRestorePoints/fb87163e-687d-4006-96c9-0451b5423b85/mounts/1/e:/documentation%2014/offers.docx?action=download
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: None |