This is an archive version of the document. To get the most up-to-date information, see the current version.

Perform File-Level Restore

You can can restore corrupted or missing files and folders of an EC2 instance to a restore point with the specified ID.

Note

Veeam Backup for AWS uses a worker instance as a staging server to perform file-level restore. During the restore process, Veeam Backup for AWS launches the worker instance and mounts volumes of a backed-up EC2 instance to it. Once the volumes are mounted, Veeam Backup for AWS allows you to use the Veeam Backup browser to find and save the necessary files and folders to the local machine.

Request

To perform a file-level restore (FLR) to a specific EC2 instance restore point, send the HTTP POST request to the /vmRestorePoints/{vmRestorePointId}/restoreFile endpoint. {vmRestorePointId} is a system ID assigned to the restore point of an EC2 instance in the Veeam Backup for AWS REST API.

HTTP Request

POST https://<hostname>:<port>/api/v1/vmRestorePoints/{vmRestorePointId}/restoreFile

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

x-api-version

Required

1.0-rev0

Specifies the current revision of the Veeam Backup for AWS REST API.

Content-Type

Required

application/json

Identifies a media type that is used in the body of the request.

Accept

Optional

  • application/json
  • application/problem+json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Request Body

To perform FLR operation, send the reason parameter in the request body in the following format:

{

 "reason": "string"

}

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns a 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

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for AWS returns the session ID of the restore operation and the URL of the Veeam Backup browser where the file system tree of the EC2 instance is displayed. For the session log details, see Get Session Log Details.

Perform File-Level RestoreExample

The following request starts the FLR operation of the EC2 instance to a restore point with the ID 3a250d36-ac51-4e2e-993a-7e4951ec48a7.

Request:

GET https://135.169.170.192:11005/api/v1/vmRestorePoints/3a250d36-ac51-4e2e-993a-7e4951ec48a7/restoreFile

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

Content-Type: application/json

 

Request Body:

{

 "reason": "Restoring missing files"

}

 

Response:

202

 

Response Body:

{

 "sessionId": "cb7b83bc-ca21-40a0-8d67-c57b34498785",

 "url": "https://127.0.0.1:443",

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/sessions/cb7b83bc-ca21-40a0-8d67-c57b34498785"

   }

 ]

}