Veeam Backup & Replication 13
REST API Reference
Related documents

Backup Browsers

The Backup Browser section defines paths and operations for browsing the file system, comparing files and folders, and performing file restore.

Get All File Restore Mounts

The HTTP GET request to the /api/v1/backupBrowser/flr path allows you to get an array of all active file restore mounts.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of mounts to skip.

limit
integer <int32>

Maximum number of mounts to return.

orderColumn
string (EFlrBrowseMountFiltersOrderColumn)

Sorts mounts by one of the mount parameters.

Value: "CreationTime"
orderAsc
boolean

Sorts mounts in the ascending order by the orderColumn parameter.

header Parameters
x-api-version
required
string
Default: 1.1-rev1

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/backupBrowser/flr
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get File Restore Mount
The HTTP GET request to the /api/v1/backupBrowser/flr/{sessionId} path allows you to get a file restore mount that was created by a restore session that has the specified sessionId.
Available to: Veeam Backup Administrator, Veeam Restore Operator.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
ID of the restore session.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev1
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/backupBrowser/flr/{sessionId}
Request samples 
Response samples 
application/json
{
  • "type": "Linux",
  • "sessionId": "1dc723e8-12a0-4480-bc34-6cb117d3d4a1",
  • "properties": {
    },
  • "sourceProperties": {
    }
}
Browse File System
The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/browse path allows you to browse file system items (drives, folders, files and links)(drives, folders, files and links) available in a restore session that has the specified sessionId.
You can use this request in the following cases:
  • To browse the file system before you restore an item
  • To check the item state (changed, not changed, and so on) after you have compared the item in the backup and on the production machine
    • Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    path
    required
    string
    Browsing path.
    

     
    object (FlrBrowseFiltrationModel) 
    Filter settings.
    

     
    object (FlrBrowseOrderSpec) 
    Sorting settings.
    

     
    object (PaginationSpec) 
    Pagination settings.
    

     
    Responses 
    200
    OK
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/browse
    Request samples 
    application/json
    {
    • "path": ""
    }
    Response samples 
    application/json
    {
    • "path": "C:\\Users",
    • "items": [
      ],
    • "pagination": {
      }
    }
    Compare Attributes
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/compareAttributes path allows you to compare attributes of file system items (drives, folders, files and links) from a restore session that has the specified sessionId with attributes of original items. 
     
    NOTE
    The operation is allowed for Microsoft Windows machines only.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    path
    required
    string
    Path to the item whose attributes you want to compare.
    

     
    showUnchangedAttributes
    boolean
    If true, unchanged item attributes are also returned.
    

     
    Responses 
    200
    OK
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    405
    Method not allowed. Indicates that the server knows the request method, but the target resource doesn't support this method.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/compareAttributes
    Request samples 
    application/json
    {
    • "path": "C:\\Users\\sheila.d.cory\\Documents",
    • "showUnchangedAttributes": true
    }
    Response samples 
    application/json
    {
    • "path": "C:\\Users\\sheila.d.cory\\Documents",
    • "attributes": [
      ]
    }
    Compare Files and Folders
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/compareToProduction path allows you to compare file system items (drives, folders, files and links) on the production machine with the items available in a restore session that has the specified sessionId. After the comparison completes, check the comparison results using the Browse Files and Folders request.
     
    NOTE
    The operation is allowed for Microsoft Windows machines only.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    isEnabled
    required
    boolean
    If true, the paths are included in the comparison. Otherwise, they are excluded from the comparison.
    

     
    paths
    required
    Array of strings
    Array of item paths that you want to compare.
    

     
    Responses 
    200
    OK
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    405
    Method not allowed. Indicates that the server knows the request method, but the target resource doesn't support this method.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/compareToProduction
    Request samples 
    application/json
    {
    • "IsEnabled": true,
    • "paths": [
      ]
    }
    Response samples 
    application/json
    { }
    Search for Files and Folders
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/search path allows you to create a search task to find required file system items (drives, folders, files and links) available in a restore session that has the specified sessionId. 
    To get the search results, use the Browse Search Results request. 
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    path
    required
    string
    Search path.
    

     
    searchString
    required
    string
    Search string. The following wildcard characters are supported: "*", "?" and "+".
    

     
    Responses 
    201
    An FlrSearch task has been created to search for file system items. To check the progress, track the task state.
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/search
    Request samples 
    application/json
    {
    • "path": "C:\\Users\\sheila.d.cory\\Documents",
    • "searchString": "*docx"
    }
    Response samples 
    application/json
    {
    • "type": "FlrSearch",
    • "state": "Starting",
    • "result": "None",
    • "id": "32d764f7-18b0-47d9-8e34-1be27bc32d3b",
    • "name": "Search files on VM winsp01",
    • "progressPercent": 0,
    • "creationTime": "2023-11-07T17:41:51.32221+01:00",
    • "endTime": null
    }
    Browse Search Results
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/search/{taskId}/browse path allows you to browse search results of a search task that has the specified taskId. 
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    taskId
    required
    string <uuid> 
    ID of the search task.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    object (PaginationSpec) 
    Pagination settings.
    

     
    object (FlrSearchForResultOrderSpec) 
    Sorting settings.
    

     
    Responses 
    200
    OK
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/search/{taskId}/browse
    Request samples 
    application/json
    {
    • "order": {
      }
    }
    Response samples 
    application/json
    {
    • "path": "C:\\Users\\sheila.d.cory\\Documents",
    • "searchString": "*docx",
    • "items": [
      ],
    • "pagination": {
      }
    }
    Restore Files and Folders to Original Location
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/restore path allows you to restore file system items (folders, files and links) to the original location.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    sourcePath
    required
    Array of strings
    Array of paths to the items that you want to restore.
    

     
    restoreType
    required
    string (EFlrRestoreType) 
    Restore type.
    

     Enum: "Overwrite" "Keep" "PermissionOnly"  
    credentialsId
    string <uuid> 
    ID of a credentials record used to connect to the target machine. Allowed only for Linux machines.
    

     
    Responses 
    201
    An FlrRestore task has been created to restore the items. To check the progress, track the task state.
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/restore
    Request samples 
    application/json
    {
    • "sourcePath": [
      ],
    • "restoreType": "Keep"
    }
    Response samples 
    application/json
    {
    • "type": "FlrRestore",
    • "state": "Starting",
    • "result": "None",
    • "id": "aabc5716-417b-4761-94a8-59ef21113ed2",
    • "name": "winsp01",
    • "progressPercent": 0,
    • "creationTime": "2023-11-07T18:22:17.8433688+01:00",
    • "endTime": null
    }
    Restore Files and Folders to Another Location
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/restoreTo path allows you to restore file system items (folders, files and links) to another location.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    sourcePath
    required
    Array of strings
    Array of paths to the items that you want to restore.
    

     
    restoreType
    required
    string (EFlrRestoreType) 
    Restore type.
    

     Enum: "Overwrite" "Keep" "PermissionOnly"  
    credentialsId
    required
    string <uuid> 
    ID of a credentials record used to connect to the target machine.
    

     
    required
    object (FlrRestoreTargetHostModel) 
    Target machine. To get an invetory object, use the Get Inventory Objects request.
    

     
    targetPath
    required
    string
    Path to the target folder.
    

     
    Responses 
    201
    An FlrRestore task has been created to restore the items. To check the progress, track the task state.
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/restoreTo
    Request samples 
    application/json
    {
    • "sourcePath": [
      ],
    • "restoreType": "Overwrite",
    • "credentialsId": "c0940fba-7c6e-445e-bea3-c0fa20e9ef15",
    • "targetHost": {
      },
    • "targetPath": "C:\\temp"
    }
    Response samples 
    application/json
    {
    • "type": "FlrRestore",
    • "state": "Starting",
    • "result": "None",
    • "id": "aabc5716-417b-4761-94a8-59ef21113ed2",
    • "name": "winsp01",
    • "progressPercent": 0,
    • "creationTime": "2023-11-07T18:22:17.8433688+01:00",
    • "endTime": null
    }
    Prepare Files and Folders for Download
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/prepareDownload path allows you to prepare files and folders for download and pack them into a ZIP file. In response, a download task is created. 
    To download the ZIP file, specify the task ID in the Download Files and Folders request. 
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    sourcePath
    required
    Array of strings
    Array of paths to the items that you want to download.
    

     
    Responses 
    201
    An FlrDownload task has been created to restore the items. To check the progress, track the task state.
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/prepareDownload
    Request samples 
    application/json
    {
    • "sourcePath": [
      ]
    }
    Response samples 
    application/json
    {
    • "additionalInfo": null,
    • "type": "FlrDownload",
    • "state": "Working",
    • "result": "None",
    • "id": "82ac5bd1-36bb-4980-b79e-0634f90c5754",
    • "name": "FLR Download from VM winsp01",
    • "progressPercent": 0,
    • "creationTime": "2023-11-07T21:24:36.7715523+01:00",
    • "endTime": null
    }
    Download Files and Folders
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/prepareDownload/{taskId}/download path allows you to download a ZIP archive with files and folders of a download task that has the specified taskId. 
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    ID of the restore session.
    

     
    taskId
    required
    string <uuid> 
    ID of the download task.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.1-rev1
    Version and revision of the client REST API. Must be in the following format: <version>-<revision>.
    

     
    Request Body schema: application/json
    required
    sourcePath
    required
    Array of strings
    Array of paths to the items that you want to download.
    

     
    Responses 
    200
    OK
    

    400
    Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
    

    401
    Unauthorized. The authorization header has been expected but not found (or found but is expired).
    

    403
    Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
    

    500
    Internal server error. The request has been received but could not be completed because of an internal error at the server side.
    

    post/api/v1/backupBrowser/flr/{sessionId}/prepareDownload/{taskId}/download
    Request samples 
    application/json
    {
    • "sourcePath": [
      ]
    }
    Response samples 
    application/json
    {
    • "errorCode": "AccessDenied",
    • "message": "string",
    • "resourceId": "string"
    }