Perform File-Level Restore

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

Note

Veeam Backup for Microsoft Azure uses a worker instance as a staging server to perform file-level restore. During the restore process, Veeam Backup for Microsoft Azure launches the worker instance and mounts volumes of a backed-up Azure VMs to it. Once the volumes are mounted, Veeam Backup for Microsoft Azure allows you to use the File Level Recovery for 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 Azure VM restore point, send the HTTP POST request to the /restorePoints/{restorePointId}/restoreFile endpoint. {restorePointId} is a system ID assigned to the restore point of an Azure VM in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

POST https://<hostname>/api/v2/restorePoints/{restorePointId}/restoreFile

Request Headers

The request contains the following headers.

Header

Required

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.

Request Body

To perform FLR restore operation, use the JobSessionV2 schema to send parameters in the request body.

Set the parameter values in the following format:

{

 "reason": "string"

}

 

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

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 Microsoft Azure returns the session ID. To retrieve a URL of the File Level Recovery for Veeam Backup browser where the file system with hierarchical directory structure will be displayed, send the HTTP request to the Job Sessions.

Note

It make take some to launch the File Level Recovery for Veeam Backup browser. To track the progress of the restore, see session log details.

Perform File-Level RestoreExample

The following request starts the FLR session to restore files and folders using the ID 3a250d36-ac51-4e2e-993a-7e4951ec48a7.

Request:

POST https://51.11.247.127/api/v2/restorePoints/3a250d36-ac51-4e2e-993a-7e4951ec48a7/restoreFile

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

"reason": "flr_session"

}

 

Response:

200

 

Response Body:

{

 "id": "44dffae7-0792-42da-ac95-6b5248e2ff0e",

 "type": "FileLevelRestore",

 "localizedType": "File-level Recovery",

 "status": "Pending",

 "usn": 187,

 "fileLevelRestoreJobInfo": {

   "initiator": "admin",

   "reason": "none",

   "vmId": "4w376jgoh5yd8xrxbmzjpq9f7f75gs89r4t4u1bo7of1f9imt5my",

   "restorePointCreatedDateUtc": "2020-11-29T18:00:15.247897Z"

 },

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/jobSessions/44dffae7-0792-42da-ac95-6b5248e2ff0e"

   },

   "log": {

     "href": "https://51.11.247.127/api/v2/jobSessions/44dffae7-0792-42da-ac95-6b5248e2ff0e/log"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.