Restoring Files and Folders

Using Veeam Backup & Replication REST API, you can restore files and folders from backups (Microsoft Windows and other file systems) and replicas (Microsoft Windows file systems).

To restore files and folders, take the following steps:

Start the restore session and mount the machine file system to the mount server.
Perform restore operations.
Stop the restore session.

Mounting File System

To mount the file system to the mount server, do the following:

Get a restore point from a backup or a replica.

To get a restore point from a backup, perform the following steps:

To get the backup object from which you want to restore files or folders, send the Get All Backup Objects request. Save the backup object ID that you need.
To get the necessary restore point from the backup object, use the Get Restore Points request, using the backup object ID. Save the restore point ID that you need.

Alternatively, you can use the Get All Restore Points request to get an array of all backup restore points created on the backup server. Save the restore point ID that you need.

To get a restore point from a replica, perform the following steps:

To get the replica from which you want to restore files or folders, send the Get All Replicas request. Save the replica ID that you need.
To get the necessary restore point from the replica, use the Get All Replica Restore Points request, using the replica ID. Save the restore point ID that you need.

Alternatively, you can use the Get All Replica Restore Points request to get an array of all replica restore points created on the backup server. Save the restore point ID that you need.

Get the necessary credentials ID with the Get All Credentials request. To add a new credentials record, use the Add Credentials Record request. This step is not necessary when restoring files or folders from a Windows-based server to the original location.
Mount the file system to the mount server with the Start File Restore request. In response, you will receive a FileLevelRestore session. Save the restore session ID to use it for restore operations.

Performing Restore

To restore files and folders, take the following steps:

[Optional] If you have a Windows machine, use the Compare Files and Folders request to compare file system items (drives, folders, files and links) on the production machine with the items available in the FileLevelRestore session.
[Optional] If you want to search for a specific file or folder, use the Search for Files and Folders and Browse Search Results requests. These requests allow you to preview the hierarchy tree of the mounted files and folders. If you specify an empty path in the request body, you will browse the root folder, and then you can go deeper into the tree.
To restore the necessary files or folders you can perform any of the following operations:

To restore files and folders, send the Restore Files and Folders to Original Location or Restore Files and Folders to Another Location request.
To download a ZIP archive with files and folders to the machine where the Veeam Backup & Replication console is installed, send the Download Files and Folders request.
[For unstructured data] To copy files and folders to the machine where the Veeam Backup & Replication console is installed or to a network shared folder, send the Copy Files and Folders to Specific Folder request.

Stopping Browser Session

To stop the mount session and unmount the file system from the mount point, send the Unmount File System request. This step is obligatory if you have disabled autoUnmount in the Start File Restore request body.

Example

In this example, you will restore a folder from a backup of a Windows VM (winsrv88) to another location. To do this, take the following steps:

Get an array of VMs that are included in backups created by the backup server.

Restoring Files and Folders Request Example

Request

POST https://backupserver01:9419/api/v1/backupObjects

Request Header

x-api-version:1.2-rev0

Authorization: Bearer eyJhbGciOiJSUzUxMiIsImtpZCI6IkY3ODA4RDFFNTNDRTNCNTU0MTBBOTFBRTcwNUMxMTY0MUQ2NDFFRTciLCJ0eXAiOiJKV1QifQ.eyJ1bmlxdWVfbmFtZSI6IlRFQ0hcXHNoZWlsYS5kLmNvcnkiLCJuYmYiOjE3MzI4MDY0ODEsImV4cCI6MTczMjgxMDA4MSwiaWF0IjoxNzMyODA2NDgxLCJhdWQiOiJhY2Nlc3MifQ.tVXCJBBIhaPzbVyy2ZhqPofs98u47m4osgLFhjC1XfMO88N7sKVvxqfmfcL5YoIVN7KbRiWoS7qNC1_-rZXUaHsqqae2HiNhGksSoJcB3SJlI3QxcZmle90ChmZQ4hLpxVaQcjwxTyoIMDksYXAPpIvuGUNNR-kyMos9RLePfFzl6iGhePq2llPyapRXW7Sy44w-6ld1H3lG1cknHcD8FmA_sfMwRe6D9o3hZrTKnBn_1xnyS6nnrlLEtTaS3M8qJJg0vwteFPN--0koGA_Zp4sWhpdsMy8uB5bioNL1Hv161yFNVzJq0VmZ2e2P2rL6FdAb_8m0fLfflpitYDPQIQ

Request Body

{}

In response, you receive an array of objects with information about backup objects. Save the id property of the necessary backup object, you will require it later.

Restoring Files and Folders Response Example

Response

200

Response Body

{

"data": [

{

"viType": "VirtualMachine",

"objectId": "vm-1067",

"path": "vcenter01.tech.local\\Prague\\prgtwesx01.tech.local\\Enterprise\\apache05",

"platformName": "VMware",

"id": "172d0448-47d9-4fef-8ed5-155fcb2dba8b",

"name": "apache05",

"type": "VM",

"platformId": "00000000-0000-0000-0000-000000000000",

"restorePointsCount": 1

{

"platformName": "UnstructuredData",

"id": "43d188bd-2e08-49be-92fb-e54bc2a564d8",

"name": "MSFT2",

"type": "Directory",

"platformId": "00000000-0000-0000-0000-000000000000",

"restorePointsCount": 2

{

"platformName": "EntraID",

"id": "f35bb706-a0bc-47da-9adb-ac795c41f47b",

"name": "MSFT2",

"type": "EntraIdTenant",

"platformId": "00000000-0000-0000-0000-000000000000",

"restorePointsCount": 7

{

"viType": "VirtualMachine",

"objectId": "vm-1059",

"path": "",

"platformName": "VMware",

"id": "63355ddf-f918-450a-86f9-ad9c84d4fddf",

"name": "winsrv88",

"type": "VM",

"platformId": "00000000-0000-0000-0000-000000000000",

"restorePointsCount": 6

}

"pagination": {

"total": 4,

"count": 4,

"skip": 0,

"limit": 200

}

To get the necessary restore point ID of this object, use the Get Restore Points request. Specify the id parameter that you saved in the previous step.

Restoring Files and Folders Request Example

Request

POST https://backupserver01:9419/api/v1/backupObjects/63355ddf-f918-450a-86f9-ad9c84d4fddf/restorePoints

Request Header

x-api-version:1.2-rev0

Request Body

{}

In response, you receive the 200 code and an array of restore points. Save the id property of the necessary restore point, you will require it later.

Restoring Files and Folders Response Example

Response

200

Response Body

{

"data": [

{

"platformName": "VMware",

"type": "Increment",

"malwareStatus": "Clean",

"id": "e8651347-4dd9-4811-a4af-809b60a10420",

"name": "winsrv88",

"platformId": "00000000-0000-0000-0000-000000000000",

"creationTime": "2024-11-25T10:00:55.482485+01:00",

"backupId": "de098d6a-7344-4398-b34e-f00c01fc5b0b",

"sessionId": null,

"allowedOperations": [

"StartViVMInstantRecovery",

"StartEntireVmRestore",

"StartFCDInstantRecovery",

"StartFlrRestore"

"backupFileId": "5f6599e2-bb20-4022-b380-266f4d8ec07c"

{

"platformName": "VMware",

"type": "Increment",

"malwareStatus": "Clean",

"id": "6e55ebcf-2d72-404d-b40f-b6ad8749c522",

"name": "winsrv88",

"platformId": "00000000-0000-0000-0000-000000000000",

"creationTime": "2024-11-24T10:00:59.401008+01:00",

"backupId": "de098d6a-7344-4398-b34e-f00c01fc5b0b",

"sessionId": null,

"allowedOperations": [

"StartViVMInstantRecovery",

"StartEntireVmRestore",

"StartFCDInstantRecovery",

"StartFlrRestore"

"backupFileId": "a4379fbe-7fab-413c-89c9-1bbf1c3a4a1e"

{

"platformName": "VMware",

"type": "Full",

"malwareStatus": "Clean",

"id": "16d20b42-cd5b-4d64-a422-04f4b13a0bae",

"name": "winsrv88",

"platformId": "00000000-0000-0000-0000-000000000000",

"creationTime": "2024-11-23T10:01:04.504937+01:00",

"backupId": "de098d6a-7344-4398-b34e-f00c01fc5b0b",

"sessionId": null,

"allowedOperations": [

"StartViVMInstantRecovery",

"StartEntireVmRestore",

"StartFCDInstantRecovery",

"StartFlrRestore"

"backupFileId": "1dc469dc-28f0-4471-a6fd-19e787ee33e2"

{

"platformName": "VMware",

"type": "Increment",

"malwareStatus": "Clean",

"id": "d0eebbad-7a71-4615-b186-71c127d26a5c",

"name": "winsrv88",

"platformId": "00000000-0000-0000-0000-000000000000",

"creationTime": "2024-11-22T10:01:06.717724+01:00",

"backupId": "de098d6a-7344-4398-b34e-f00c01fc5b0b",

"sessionId": null,

"allowedOperations": [

"StartViVMInstantRecovery",

"StartEntireVmRestore",

"StartFCDInstantRecovery",

"StartFlrRestore"

"backupFileId": "c2b8e176-a64f-463e-9354-b174864723ee"

{

"platformName": "VMware",

"type": "Increment",

"malwareStatus": "Clean",

"id": "111407db-5f33-4401-8edf-a8713baf5a74",

"name": "winsrv88",

"platformId": "00000000-0000-0000-0000-000000000000",

"creationTime": "2024-11-21T10:01:03.661786+01:00",

"backupId": "de098d6a-7344-4398-b34e-f00c01fc5b0b",

"sessionId": null,

"allowedOperations": [

"StartViVMInstantRecovery",

"StartEntireVmRestore",

"StartFCDInstantRecovery",

"StartFlrRestore"

"backupFileId": "e95a768e-8832-4ffe-9728-a2b1f0e9aeae"

{

"platformName": "VMware",

"type": "Full",

"malwareStatus": "Clean",

"id": "f0dcb950-5eff-417d-8a3c-dc00cb12c1b9",

"name": "winsrv88",

"platformId": "00000000-0000-0000-0000-000000000000",

"creationTime": "2024-11-20T21:43:33.129736+01:00",

"backupId": "de098d6a-7344-4398-b34e-f00c01fc5b0b",

"sessionId": null,

"allowedOperations": [

"StartViVMInstantRecovery",

"StartEntireVmRestore",

"StartFCDInstantRecovery",

"StartFlrRestore"

"backupFileId": "98ebdfa2-0f57-44ec-b702-63f8e0a400ca"

}

"pagination": {

"total": 6,

"count": 6,

"skip": 0,

"limit": 6

}

To get the necessary credentials ID, use the Get All Credentials request.

Restoring Files and Folders Request Example

Request

POST https://backupserver01:9419/api/v1/credentials

Request Header

x-api-version:1.2-rev0

Request Body

{}

In response, you receive the 200 code and an array of credential records. Save the id property value of the credential record you need.

Restoring Files and Folders Response Example

Response

200

Response Body

{

"data": [

{

"uniqueId": "fd0041d1-4a68-4abd-aefe-b2bf02bb7ca9",

"type": "Standard",

"id": "fd0041d1-4a68-4abd-aefe-b2bf02bb7ca9",

"username": "root",

"description": "Provider-side network extension appliance credentials",

"creationTime": "2024-10-08T20:36:10.754218+02:00"

{

"uniqueId": "3b4a4b21-9aee-4c79-946e-30b1b3b570a3",

"type": "Standard",

"id": "3b4a4b21-9aee-4c79-946e-30b1b3b570a3",

"username": "tech\\administrator",

"description": "tech\\administrator",

"creationTime": "2024-10-09T20:29:27.895519+02:00"

{

"uniqueId": "633983b0-149b-4659-8585-3b81eb3a13fe",

"type": "Standard",

"id": "633983b0-149b-4659-8585-3b81eb3a13fe",

"username": "tech\\sheila.d.cory",

"description": "tech\\sheila.d.cory",

"creationTime": "2024-10-09T20:30:29.061333+02:00"

}

"pagination": {

"total": 3,

"count": 3,

"skip": 0,

"limit": 200

}

Mount the file system to the mount server with the Start File Restore request.

Restoring Files and Folders Request Example

Request

POST https://backupserver01:9419/api/v1/restore/flr

Request Header

x-api-version:1.2-rev0

Request Body

{

"restorePointId": "f0dcb950-5eff-417d-8a3c-dc00cb12c1b9",

"type": "Windows",

"autoUnmount": {

"isEnabled": true,

"noActivityPeriodInMinutes": 10

"credentialsId": "633983b0-149b-4659-8585-3b81eb3a13fe"

}

In response, you receive an object containing file restore mount points. Save the sessionId property value for later use.

Restoring Files and Folders Response Example

Response

201

Response Body

{

"type": "Windows",

"sessionId": "7db36e08-9b1d-4377-bb8b-5b40bd2cd140",

"properties": {

"pathSeparator": "\\"

"sourceProperties": {

"machineName": "winsrv88",

"restorePointName": "winsrv88"

}

Browse the file system using the sessionId parameter from the previous response.

Restoring Files and Folders Request Example

Request

POST https://backupserver01:9419/api/v1/backupBrowser/flr/7db36e08-9b1d-4377-bb8b-5b40bd2cd140/browse

Request Header

x-api-version:1.2-rev0

Request Body

{

"path": "C:\\Users\\sheila.d.cory\\Desktop"

}

In response, you receive the 200 code and an array of items in the specified path.

Restoring Files and Folders Response Example

Response

200

Response Body

{

"path": "C:\\Users\\sheila.d.cory\\Desktop",

"items": [

{

"type": "Folder",

"itemState": "NotAvaliable",

"location": "C:\\Users\\sheila.d.cory\\Desktop",

"name": "Projects",

"size": 0,

"creationDate": "2021-02-05T01:33:02.7416651+01:00",

"modifiedDate": "2021-02-09T17:14:33.0974859+01:00"

{

"type": "Folder",

"itemState": "NotAvaliable",

"location": "C:\\Users\\sheila.d.cory\\Desktop",

"name": "Reports",

"size": 0,

"creationDate": "2021-02-08T11:54:34.4471425+01:00",

"modifiedDate": "2021-02-08T11:54:34.4471425+01:00"

{

"type": "Folder",

"itemState": "NotAvaliable",

"location": "C:\\Users\\sheila.d.cory\\Desktop",

"name": "Tasks",

"size": 0,

"creationDate": "2023-02-02T21:53:49.449624+01:00",

"modifiedDate": "2021-02-08T11:54:34.4471425+01:00"

{

"type": "File",

"itemState": "NotAvaliable",

"location": "C:\\Users\\sheila.d.cory\\Desktop",

"name": "desktop.ini",

"size": 476,

"creationDate": "2020-03-02T10:23:03.0272872+01:00",

"modifiedDate": "2024-10-23T20:04:33.2495488+02:00"

}

"pagination": {

"total": 4,

"count": 4,

"skip": 0,

"limit": 200

}

Get information about the target server.

Request

POST https://backupserver01:9419/api/v1/inventory/vcenter01.tech.local

Request Header

x-api-version:1.2-rev0

Request Body

{}

In response, you receive the 200 code and an array of inventory objects on the host. Save the inventory object of the server to which you want to restore your folder.

Restoring Files and Folders Response Example

Response

200

Response Body

{

"data": [

{

"type": "VirtualMachine",

"hostName": "vcenter01.tech.local",

"name": "srv113",

"objectId": "vm-34006",

"urn": "vc:vcenter01.tech.local;folder:group-d1;datacenter:datacenter-1001;folder:group-h1003;computeresource:domain-s1006;hostsystem:host-1008;resourcepool:resgroup-1023;virtualmachine:vm-34006",

"platform": "VMware",

"size": "71.9 GB"

{

"type": "VirtualMachine",

"hostName": "vcenter01.tech.local",

"name": "srv95",

"objectId": "vm-34740",

"urn": "vc:vcenter01.tech.local;folder:group-d1;datacenter:datacenter-1001;folder:group-h1003;computeresource:domain-s1006;hostsystem:host-1008;resourcepool:resgroup-1023;virtualmachine:vm-34740",

"platform": "VMware",

"size": "271.7 GB"

{

"type": "VirtualMachine",

"hostName": "vcenter01.tech.local",

"name": "dlsql02",

"objectId": "vm-4698",

"urn": "vc:vcenter01.tech.local;folder:group-d1;datacenter:datacenter-1001;folder:group-h1003;computeresource:domain-s1006;hostsystem:host-1008;resourcepool:resgroup-1023;virtualmachine:vm-4698",

"platform": "VMware",

"size": "121.2 GB"

{

"type": "VirtualMachine",

"hostName": "vcenter01.tech.local",

"name": "enterprise02",

"objectId": "vm-30106",

"urn": "vc:vcenter01.tech.local;folder:group-d1;datacenter:datacenter-1001;folder:group-h1003;computeresource:domain-s1006;hostsystem:host-1008;resourcepool:resgroup-1023;virtualmachine:vm-30106",

"platform": "VMware",

"size": "158.2 GB"

{

"type": "VirtualMachine",

"hostName": "vcenter01.tech.local",

"name": "winorcl01",

"objectId": "vm-1208",

"urn": "vc:vcenter01.tech.local;folder:group-d1;datacenter:datacenter-1001;folder:group-h1003;computeresource:domain-s1006;hostsystem:host-1008;resourcepool:resgroup-1023;virtualmachine:vm-1208",

"platform": "VMware",

"size": "63.3 GB"

}

"pagination": {

"total": 4,

"count": 4,

"skip": 0,

"limit": 200

"hierarchyType": null

}

Restore the folder.

Request

POST https://backupserver01:9419/api/v1/backupBrowser/flr/7db36e08-9b1d-4377-bb8b-5b40bd2cd140/restoreTo

Request Header

x-api-version:1.2-rev0

Request Body

{

"sourcePath": [

"C:\\Users\\sheila.d.cory\\Desktop\\Reports"

"restoreType": "Overwrite",

"credentialsId": "633983b0-149b-4659-8585-3b81eb3a13fe",

"targetHost": {

"type": "VMware",

"vmObject": {

"type": "VirtualMachine",

"hostName": "vcenter01.tech.local",

"name": "enterprise02",

"objectId": "vm-30106",

"urn": "vc:vcenter01.tech.local;folder:group-d1;datacenter:datacenter-1001;folder:group-h1003;computeresource:domain-s1006;hostsystem:host-1008;resourcepool:resgroup-1023;virtualmachine:vm-30106",

"platform": "VMware",

"size": "158.2 GB"

}

"targetPath": "C:\\Users\\sheila.d.cory\\Desktop\\Reports"

}

In response, you receive the 201 code and an FlrRestore task. To check the progress, track the task state.

Restoring Files and Folders Response Example

Response

201

Response Body

{

"type": "FlrRestore",

"state": "Starting",

"result": "None",

"id": "18672bf4-ed87-4448-8138-58ecdbce0d3d",

"name": "winsrv88",

"progressPercent": 0,

"creationTime": "2024-11-29T12:12:52.4027643+01:00",

"endTime": null

}

If you have disabled autoUnmount in the Start File Restore request body, you must manually unmount the file system from the mount point.

Request

POST https://backupserver01:9419/api/v1restore/flr/7db36e08-9b1d-4377-bb8b-5b40bd2cd140/unmount

Request Header

x-api-version:1.2-rev0

Request Body

{}

In response, you receive the 201 code and a FileLevelRestore session informing you that the session is stopped and the file system has been unmounted.

Restoring Files and Folders Response Example

Response

201

Response Body

{

"sessionType": "FileLevelRestore",

"state": "Stopped",

"platformName": null,

"id": "7db36e08-9b1d-4377-bb8b-5b40bd2cd140",

"name": "FLR_[winsrv88]",

"jobId": "339fb482-fab2-44e6-9368-fc42008901aa",

"creationTime": "2024-11-29T15:27:16.531659+01:00",

"endTime": "2024-11-29T15:28:59.137366+01:00",

"progressPercent": 0,

"result": {

"result": "Success",

"message": "Success",

"isCanceled": null

"resourceId": null,

"resourceReference": null,

"parentSessionId": null,

"usn": 0,

"platformId": null

}