Veeam Backup & Replication 13
REST API Reference
Related documents

Backup Browsers

Backup browser allows you to perform the following operations:

  • Browse the file system, compare files and folders, and perform file restore.
  • Browse Microsoft Entra ID tenant backups, compare Microsoft Entra ID items, and restore entire items or their properties.
  • Browse the Microsoft Entra ID log files, compare files and folders, and restore Microsoft Entra ID logs.

Get All File Restore Mount Points

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

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of mount points to skip.

limit
integer <int32>

Maximum number of mount points to return.

orderColumn
string (EFlrBrowseMountFiltersOrderColumn)

Sorts mount points by one of the mount point parameters.

Value: "CreationTime"
orderAsc
boolean

If true, sorts mount points in the ascending order by the orderColumn parameter.

header Parameters
x-api-version
required
string
Default: 1.2-rev0

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 Point
The HTTP GET request to the /api/v1/backupBrowser/flr/{sessionId} path allows you to get a file restore mount point 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> 
Restore session ID.


 
header Parameters
x-api-version
required
string
 Default:  1.2-rev0
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) 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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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> 
    Restore session ID.
    

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

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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 inventory 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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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> 
    Restore session ID.
    

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

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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"
    }
    Get All Unstructured Data Mount Points
    The HTTP GET request to the /api/v1/backupBrowser/flr/unstructuredData path allows you to get an array of all active unstructured data mount points.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    query Parameters
    skip
    integer <int32> 
    Number of mount points to skip.
    

     
    limit
    integer <int32> 
    Maximum number of mount points to return.
    

     
    orderColumn
    string (EUnstructuredDataFlrBrowseMountFiltersOrderColumn) 
    Sorts mount points by one of the mount point parameters.
    

     Value: "CreationTime"  
    orderAsc
    boolean
    If true, sorts mount points in the ascending order by the orderColumn parameter.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/unstructuredData
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Get Unstructured Data Mount Point
    The HTTP GET request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId} path allows you to get an unstructured data mount point 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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/unstructuredData/{sessionId}
    Request samples 
    Response samples 
    application/json
    {
    • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
    • "properties": {
      },
    • "sourceProperties": {
      }
    }
    Browse Unstructured Data File System
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/browse path allows you to browse file system items (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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/unstructuredData/{sessionId}/browse
    Request samples 
    application/json
    {
    • "path": "string",
    • "filter": {
      },
    • "order": {
      },
    • "pagination": {
      }
    }
    Response samples 
    application/json
    {
    • "path": "string",
    • "items": [
      ],
    • "pagination": {
      }
    }
    Search for Files and Folders in Unstructured Data Source
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{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> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/unstructuredData/{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/unstructuredData/{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> 
    Restore session ID.
    

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

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/unstructuredData/{sessionId}/search/{taskId}/browse
    Request samples 
    application/json
    {
    • "order": {
      }
    }
    Response samples 
    application/json
    {
    • "path": "C:\\Users\\sheila.d.cory\\Documents",
    • "searchString": "*docx",
    • "items": [
      ],
    • "pagination": {
      }
    }
    Copy Files and Folders to Specific Folder
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/copyTo path allows you to copy file system items (folders, files and links) to the machine where the Veeam Backup & Replication console is installed or to a network shared folder.
    When copying symbolic links, Veeam Backup & Replication copies the content that the links point to.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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.
    

     
    restoreMode
    required
    string (EFileBackupFLRCopyToRestoreMode) 
    Restore mode.
    

     Enum: "LatestPoint" "Custom"  
    isRecursive
    boolean
    If true, all files and folders in the source path are copied recursively.
    

     
    toDateTime
    string <date-time> 
    Date when the restore point was created. Use this property when copying files and folders from an erlier restore point (the restoreMode value is Custom).
    

     
    unstructuredDataServerId
    string <uuid> 
    ID of a server where the target shared folder is located. Use this property when copying files and folders to a file share.
    

     
    path
    string
    Path to the target folder.
    

     
    copyToBackupServer
    boolean
    If true, the files and folders are copied to a folder on the machine where the Veeam Backup & Replication console is installed.
    

     
    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/unstructuredData/{sessionId}/copyTo
    Request samples 
    application/json
    {
    • "sourcePath": [
      ],
    • "isRecursive": true,
    • "restoreMode": "LatestPoint",
    • "toDateTime": "2019-08-24T14:15:22Z",
    • "unstructuredDataServerId": "5fbcd1ff-3e99-4684-a268-511e1bdc1496",
    • "path": "string",
    • "copyToBackupServer": true
    }
    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
    }
    Get Mount Points of All Entra ID Tenants
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant path allows you to get an array of all active mount points created for all Microsoft Entra ID tenants. 
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    query Parameters
    skip
    integer <int32> 
    Number of mount points to skip.
    

     
    limit
    integer <int32> 
    Maximum number of mount points to return.
    

     
    orderColumn
    string (EFlrBrowseMountFiltersOrderColumn) 
    Sorts mount points by one of the mount point parameters.
    

     Value: "CreationTime"  
    orderAsc
    boolean
    If true, sorts mount points in the ascending order by the orderColumn parameter.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/entraIdTenant
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Get Mount Point of Microsoft Entra ID Tenant
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId} path allows you to get a Microsoft Entra ID tenant mount point created by a mount session that has the specified sessionId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/entraIdTenant/{sessionId}
    Request samples 
    Response samples 
    application/json
    {
    • "sessionId": "783241eb-5b56-4456-9736-379206ffc600",
    • "sourceProperties": {
      }
    }
    Get Restore Points of Microsoft Entra ID Tenant
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/restorePoints path allows you to get an array of restore points available in a Microsoft Entra ID tenant backup that has the specified backupId. This request helps you find the restore point that you want to restore tenant items from.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

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

     
    Request Body schema: application/json
    required
    skip
    integer
    Number of restore points to skip.
    

     
    limit
    integer
    Maximum number of restore points to return.
    

     
    object (EntraIdTenantRestorePointSortingSpec) 
    Sorting options.
    

     
    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/entraIdTenant/{backupId}/restorePoints
    Request samples 
    application/json
    {
    • "limit": 5,
    • "sorting": {
      }
    }
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Get Microsoft Entra ID Items
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/browse path allows you to browse Microsoft Entra ID items available in a backup that has the specified backupId. Use this request to find the items that you want to restore. In the request body, you must specify an item type: user, group, administrative unit, role or application.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

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

     
    Request Body schema: application/json
    required
    type
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     
    skip
    integer
    Number of items to skip.
    

     
    limit
    integer
    Maximum number of items to return.
    

     
    object (EntraIdTenantUserFilterBrowseSpec) 
    Filtering options.
    

     
    object (EntraIdTenantUserSortingBrowseSpec) 
    Sorting options.
    

     
    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/entraIdTenant/{backupId}/browse
    Request samples 
    application/json
    {
    • "type": "User",
    • "filter": {
      },
    • "sorting": {
      }
    }
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Get Microsoft Entra ID Item
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/browse/{itemId} path allows you to get a specific Microsoft Entra ID item available in a tenant backup that has the specified backupId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

     
    itemId
    required
    string
    Item ID.
    

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

     
    Request Body schema: application/json
    required
    type
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     Enum: "User" "Group" "AdminUnit" "Role" "Application"  
    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/entraIdTenant/{backupId}/browse/{itemId}
    Request samples 
    application/json
    {
    • "type": "User"
    }
    Response samples 
    application/json
    {
    • "mailAddress": "test1@8bt3cp.onmicrosoft.com",
    • "userName": "test1@8bt3cp.onmicrosoft.com",
    • "userType": "Member",
    • "employeeType": "Employee",
    • "accountEnabled": true,
    • "companyName": "Veeam Software",
    • "creationType": null,
    • "department": "Marketing",
    • "country": "United States",
    • "jobTitle": "Manager",
    • "officeLocation": "Miami",
    • "type": "User",
    • "id": "fee6a1c9-6f07-4729-bf46-d3d4f45c7ad0",
    • "displayName": "Test 1",
    • "restorePointId": "e41b1345-a565-4db8-82f5-0632403630e8",
    • "restorePointDate": "2024-10-15T22:11:26.218187+02:00"
    }
    Get Restore Points of Microsoft Entra ID Item
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/browse/{itemId}/restorePoints path allows you to get restore points that were created for a Microsoft Entra ID item that has the specified itemId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

     
    itemId
    required
    string
    Item ID.
    

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

     
    Request Body schema: application/json
    optional
    skip
    integer
    Number of restore points to skip.
    

     
    limit
    integer
    Maximum number of restore points to return.
    

     
    object (EntraIdTenantRestorePointSortingSpec) 
    Sorting options.
    

     
    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/entraIdTenant/{backupId}/browse/{itemId}/restorePoints
    Request samples 
    application/json
    {
    • "limit": 5,
    • "sorting": {
      }
    }
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Validate Microsoft Entra ID Items
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/validate path allows you to validate that Microsoft Entra ID items specified in the request body are available in a specified restore point.
    In the response body, you receive an array of items that are missing in the restore point. To browse restore points that are available for each of the missing items, use the Get Restore Points of Microsoft Entra ID Item request.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

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

     
    Request Body schema: application/json
    required
    restorePointId
    required
    string <uuid> 
    Restore point ID.
    

     
    itemIds
    required
    Array of strings
    Array of Microsoft Entra ID item IDs.
    

     
    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/entraIdTenant/{sessionId}/validate
    Request samples 
    application/json
    {
    • "restorePointId": "d67eabe0-c5f1-40d9-835b-954f9b7e4b9c",
    • "itemIds": [
      ]
    }
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Check Microsoft Entra ID Items in Production
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/checkProductionItems path allows you to check if specified Entra ID items from a mounted tenant backup are available in production.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

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

     
    Request Body schema: application/json
    required
    required
    Array of objects (EntraIdTenantProductionItemSpec) 
    Array of Microsoft Entra ID items that you want to check.
    

     
    credentialId
    string <uuid> 
    ID of the credentials used to connect to the Microsoft Entra ID tenant.
    

     
    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/entraIdTenant/{sessionId}/checkProductionItems
    Request samples 
    application/json
    {
    • "items": [
      ]
    }
    Response samples 
    application/json
    {
    • "items": [
      ]
    }
    Generate Microsoft Entra ID User Passwords
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/passwords/generate path allows you to generate passwords for Microsoft Entra ID users that you want to restore.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Session ID.
    

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

     
    Request Body schema: application/json
    required
    passwordsCount
    required
    integer
    Number of passwords.
    

     
    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/entraIdTenant/{sessionId}/passwords/generate
    Request samples 
    application/json
    {
    • "passwordsCount": 5
    }
    Response samples 
    application/json
    {
    • "passwords": [
      ]
    }
    Restore Microsoft Entra ID Items
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreItems path allows you to restore Microsoft Entra ID items from a mount point with the specified sessionId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

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

     
    Request Body schema: application/json
    required
    credentialsId
    string <uuid> 
    ID of the credentials record used for connection to the target tenant. The property is used only for delegated restore by restore operator that does not have access to presaved credentials. To obtain the credentials, use the following requests: 
    1. Obtain a user code: Get User Code for Microsoft Entra ID Item Restore.
      2.  
    2. Use the user code to get the credentials ID: Get Credentials for Microsoft Entra ID Item Restore.
    

     
    Array of objects (EntraIDItemIncludeRestoreSpec) 
    Array of Microsoft Entra ID items.
    

     
    skipRelationships
    boolean
    If true, item relationships (such as assigned roles, group memberships, group ownerships, and admin unit memberships) are not restored.
    

     
    skipRecycleBinRestore
    boolean
    If true, all of the items are restored from the backup. 
    Otherwise, the items are restored from the Microsoft Entra ID recycle bin. If an item is not found in the recycle bin, it will not be restored.
    

     
    skipObjectsIfExist
    boolean
    If true, only non-existing items are restored.
    

     
    requestPasswordChangeOnLogon
    boolean
    If true, restored users will be forced to change their passwords after their first logon.
    

     
    defaultUserPassword
    string
    Default password that will be set for all users.
    

     
    Array of objects (EntraIdTenantRestoreUserPasswordSpec) 
    Array of custom user passwords. To generate the passwords, use the Generate Microsoft Entra ID User Passwords request.
    

     
    reason
    string
    Reason for restoring Microsoft Entra ID items.
    

     
    Responses 
    200
    A RestoreTenant session has been created to restore tenant items. To check the progress, track the session 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/entraIdTenant/{sessionId}/restoreItems
    Request samples 
    application/json
    {
    • "items": [
      ],
    • "skipRelationships": "false",
    • "skipRecycleBinRestore": "true",
    • "skipObjectsIfExist": "false",
    • "requestPasswordChangeOnLogon": "true",
    • "usersPasswords": [
      ],
    • "reason": "Restore corrupted items"
    }
    Response samples 
    application/json
    {
    • "state": "Running",
    • "id": "0faf31e6-e6e8-43ea-95b4-1acacbe916c4",
    • "name": "RestoreTenant",
    • "creationTime": "2024-11-15T16:23:23.2885294+01:00",
    • "endTime": "0001-01-01T00:00:00",
    • "reason": "Restore corrupted users.",
    • "parentSessionId": "b47e4f57-176f-4196-b6db-783c05729828"
    }
    Restore Microsoft Entra ID Item Properties
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreItemAttributes path allows you to restore Microsoft Entra ID item properties from a mount point with the specified sessionId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

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

     
    Request Body schema: application/json
    required
    itemType
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     Enum: "User" "Group" "AdminUnit" "Role" "Application"  
    restorePointId
    required
    string <uuid> 
    Restore point ID.
    

     
    itemId
    required
    string
    Item ID.
    

     
    credentialsId
    string <uuid> 
    ID of the credentials record used for connection to the target tenant. The property is used only for delegated restore by restore operator that does not have access to presaved credentials. To obtain the credentials, use the following requests: 
    1. Obtain a user code: Get User Code for Microsoft Entra ID Item Restore.
      2.  
    2. Use the user code to get the credentials ID: Get Credentials for Microsoft Entra ID Item Restore.
    

     
    Array of objects (EntraIdTenantItemIncludedPropertyModel) 
    Array of item properties that you want to restore.
    

     
    skipRelationships
    boolean
    If true, item relationships (such as assigned roles, group memberships, group ownerships, and admin unit memberships) are not restored.
    

     
    skipRecycleBinRestore
    boolean
    If true, all of the items are restored from the backup. 
    Otherwise, the items are restored from the Microsoft Entra ID recycle bin. If an item is not found in the recycle bin, it will not be restored.
    

     
    skipObjectsIfExist
    boolean
    If true, only non-existing items are restored.
    

     
    requestPasswordChangeOnLogon
    boolean
    If true, restored users will be forced to change their passwords after their first logon.
    

     
    defaultUserPassword
    string
    Default password that will be set for all users.
    

     
    Array of objects (EntraIdTenantRestoreUserPasswordSpec) 
    Array of custom user passwords. To generate the passwords, use the Generate Microsoft Entra ID User Passwords request.
    

     
    reason
    string
    Reason for restoring Microsoft Entra ID items.
    

     
    Responses 
    200
    A RestoreTenant session has been created to restore item properties. To check the progress, track the session 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/entraIdTenant/{sessionId}/restoreItemAttributes
    Request samples 
    application/json
    {
    • "credentialsId": "08e8bcd2-3d30-4d03-8e1a-ab6ac0cbf1ed",
    • "restorePointId": "8c843d10-6d0f-4abe-b898-e1ba18b94f68",
    • "itemId": "string",
    • "itemType": "User",
    • "includedProperties": [
      ],
    • "skipRelationships": true,
    • "skipRecycleBinRestore": true,
    • "skipObjectsIfExist": true,
    • "requestPasswordChangeOnLogon": true,
    • "defaultUserPassword": "string",
    • "usersPasswords": [
      ],
    • "reason": "string"
    }
    Response samples 
    application/json
    {
    • "state": "Running",
    • "id": "0faf31e6-e6e8-43ea-95b4-1acacbe916c4",
    • "name": "RestoreTenant",
    • "creationTime": "2024-11-15T16:23:23.2885294+01:00",
    • "endTime": "0001-01-01T00:00:00",
    • "reason": "Restore corrupted users.",
    • "parentSessionId": "b47e4f57-176f-4196-b6db-783c05729828"
    }
    Compare Microsoft Entra ID Item Properties
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/compare path allows you to compare the properties of a Microsoft Entra ID item available in a mount session that has the specified sessionId.
    You can compare item properties either between two restore points or between a restore point and production. To compare the item to production, do not specify newRestorePointId.
    This request is synchronous, meaning that the client will wait until comparison results are ready. Alternatively, you can use an asynchronous request that returns a comparison session immediately so the client can continue execution, and you can process the comparison results later when the session changes its state to Success. For details on the asynchronous request, see Start Comparing Microsoft Entra ID Item Properties.
     
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

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

     
    Request Body schema: application/json
    required
    itemId
    required
    string
    ID of Microsoft Entra ID item.
    

     
    itemType
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     Enum: "User" "Group" "AdminUnit" "Role" "Application"  
    oldRestorePointId
    required
    string <uuid> 
    ID of an earlier restore point.
    

     
    newRestorePointId
    string <uuid> 
    ID of a later restore point. If you do not specify this property, the item from the earlir restore point will be compared to the item in production.
    

     
    showUnchangedAttributes
    boolean
    If true, both changed and unchanged item properties are returned. Otherwise, only changed ones.
    

     
    reloadCache
    boolean
    This property is only used when comparing the item to production (newRestorePointId must not be specified). 
    • If true, the mount session cache will be reset for this request and new data will be obtained from Microsoft Entra ID.
      •  
    • If false, the data will be obtained from the cache.
     Resetting the cache slows down request processing but allows you to get up-to-date data. To check the time when the cache was last updated, use the cacheTimestamp property in the response body.
    

     
    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/entraIdTenant/{sessionId}/compare
    Request samples 
    application/json
    {
    • "itemId": "string",
    • "itemType": "User",
    • "oldRestorePointId": "f8a136c7-d6dc-4e4e-b870-122060cc21a6",
    • "newRestorePointId": "9836913f-c84d-4c5f-ba3f-20c254fac007",
    • "showUnchangedAttributes": true,
    • "reloadCache": true
    }
    Response samples 
    application/json
    {
    • "existsInOldRestorePoint": true,
    • "existsInNewRestorePoint": true,
    • "properties": [
      ],
    • "references": [
      ],
    • "cacheTimestamp": "2019-08-24T14:15:22Z"
    }
    Start Comparing Microsoft Entra ID Item Properties
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/startCompare path allows you to start comparison of the properties of a Microsoft Entra ID item available in a mount session that has the specified sessionId.
    You can compare item properties either between two restore points or between a restore point and production. To compare the item to production, do not specify newRestorePointId.
    This request is asynchronous, meaning that the request returns a comparison session immediately so the client can continue execution, and you can process the comparison results later when the session changes its state to Success. To get the comparison results, send the Get Comparison Results for Microsoft Entra ID Items request. For details on synchronous request, see Compare Microsoft Entra ID Item Properties.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

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

     
    Request Body schema: application/json
    required
    itemId
    required
    string
    ID of Microsoft Entra ID item.
    

     
    itemType
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     Enum: "User" "Group" "AdminUnit" "Role" "Application"  
    oldRestorePointId
    required
    string <uuid> 
    ID of an earlier restore point.
    

     
    newRestorePointId
    string <uuid> 
    ID of a later restore point. If you do not specify this property, the item from the earlir restore point will be compared to the item in production.
    

     
    showUnchangedAttributes
    boolean
    If true, both changed and unchanged item properties are returned. Otherwise, only changed ones.
    

     
    reloadCache
    boolean
    This property is only used when comparing the item to production (newRestorePointId must not be specified). 
    • If true, the mount session cache will be reset for this request and new data will be obtained from Microsoft Entra ID.
      •  
    • If false, the data will be obtained from the cache.
     Resetting the cache slows down request processing but allows you to get up-to-date data. To check the time when the cache was last updated, use the cacheTimestamp property in the response body.
    

     
    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/entraIdTenant/{sessionId}/startCompare
    Request samples 
    application/json
    {
    • "itemId": "string",
    • "itemType": "User",
    • "oldRestorePointId": "f8a136c7-d6dc-4e4e-b870-122060cc21a6",
    • "newRestorePointId": "9836913f-c84d-4c5f-ba3f-20c254fac007",
    • "showUnchangedAttributes": true,
    • "reloadCache": true
    }
    Response samples 
    application/json
    {
    • "compareSessionId": "ddb225d0-ef60-43d7-987a-33aa02582500"
    }
    Get Comparison Results for Microsoft Entra ID Items
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/compare/{compareSessionId}/result path allows you to get comparison results for Microsoft Entra ID items, initiated by a comparison session with the specified sessionId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

     
    compareSessionId
    required
    string <uuid> 
    Comparison session ID.
    

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

     
    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.
    

    get/api/v1/backupBrowser/entraIdTenant/{sessionId}/compare/{compareSessionId}/result
    Request samples 
    Response samples 
    application/json
    {
    • "status": "Running",
    • "result": {
      },
    • "errorMessage": "string"
    }
    Export Microsoft Entra ID Items
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/export path allows you to export Microsoft Entra ID items from backup that has the specified backupId to an XML or CSV file. The exported file contains all item properties that are available in the backup.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

     
    query Parameters
    toXml
    boolean
    If true, the format of the output file is XML, otherwise — CSV.
    

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

     
    Request Body schema: application/json
    required
    type
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     
    skip
    integer
    Number of items to skip.
    

     
    limit
    integer
    Maximum number of items to return.
    

     
    object (EntraIdTenantUserFilterBrowseSpec) 
    Filtering options.
    

     
    object (EntraIdTenantUserSortingBrowseSpec) 
    Sorting options.
    

     
    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/entraIdTenant/{backupId}/export
    Request samples 
    application/json
    {
    • "type": "User",
    • "filter": {
      },
    • "sorting": {
      }
    }
    Response samples 
    application/json
    {
    • "errorCode": "AccessDenied",
    • "message": "string",
    • "resourceId": "string"
    }
    Upload Microsoft Entra ID Users
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadUser path allows you to upload a CSV file and get an array of users, which is ready to be specified in the body of the restore request. The CSV file must contain a list of IDs or user principal names of Microsoft Entra ID users.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

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

     
    Request Body schema: application/octet-stream
    data
    string <binary> 
    CSV file that contains a list of IDs of Microsoft Entra ID items that you want to upload. For users, you can also specify a list of user principle names.
    

     
    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/entraIdTenant/{backupId}/uploadUser
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Groups
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadGroup path allows you to upload a CSV file and get an array of groups, which is ready to be specified in the body of the restore request. The CSV file must contain a list of IDs of Microsoft Entra ID groups.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

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

     
    Request Body schema: application/octet-stream
    data
    string <binary> 
    CSV file that contains a list of IDs of Microsoft Entra ID items that you want to upload. For users, you can also specify a list of user principle names.
    

     
    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/entraIdTenant/{backupId}/uploadGroup
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Administrative Units
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadAdministrativeUnit path allows you to upload a CSV file and get an array of administrative units, which is ready to be specified in the body of the restore request. The CSV file must contain a list of IDs of Microsoft Entra ID administrative units.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

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

     
    Request Body schema: application/octet-stream
    data
    string <binary> 
    CSV file that contains a list of IDs of Microsoft Entra ID items that you want to upload. For users, you can also specify a list of user principle names.
    

     
    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/entraIdTenant/{backupId}/uploadAdministrativeUnit
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Roles
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadRole path upload a CSV file and get an array of roles, which is ready to be specified in the body of the restore request. The CSV file must contain a list of IDs of Microsoft Entra ID roles.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

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

     
    Request Body schema: application/octet-stream
    data
    string <binary> 
    CSV file that contains a list of IDs of Microsoft Entra ID items that you want to upload. For users, you can also specify a list of user principle names.
    

     
    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/entraIdTenant/{backupId}/uploadRole
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Applications
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadApplication path  allows you to upload a CSV file and get an array of applications, which is ready to be specified in the body of the restore request. The CSV file must contain a list of IDs of Microsoft Entra ID applications.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID.
    

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

     
    Request Body schema: application/octet-stream
    data
    string <binary> 
    CSV file that contains a list of IDs of Microsoft Entra ID items that you want to upload. For users, you can also specify a list of user principle names.
    

     
    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/entraIdTenant/{backupId}/uploadApplication
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Get All Restore Sessions of Microsoft Entra ID Tenant
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreSessions path allows you to get an array of restore sessions that were started for a Microsoft Entra ID tenant mount point with the specified sessionId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/entraIdTenant/{sessionId}/restoreSessions
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Get Restore Session of Microsoft Entra ID Tenant
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/restoreSessions/{restoreSessionId} path allows you to get a restore session that has the specified restoreSessionId.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

     
    restoreSessionId
    required
    string <uuid> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId}
    Request samples 
    Response samples 
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "creationTime": "2019-08-24T14:15:22Z",
    • "endTime": "2019-08-24T14:15:22Z",
    • "state": "Running",
    • "reason": "string",
    • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344"
    }
    Get Restore Session Logs of Microsoft Entra ID Tenant
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId}/logs path allows you to get restore session logs of a Microsoft Entra ID tenant.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

     
    restoreSessionId
    required
    string <uuid> 
    Restore session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.2-rev0
    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/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId}/logs
    Request samples 
    Response samples 
    application/json
    {
    • "totalRecords": 0,
    • "records": [
      ]
    }
    Stop Restore Session of Microsoft Entra ID Tenant
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId}/stop path allows you to stop a restore session of a Microsoft Entra ID tenant.
    Available to: Veeam Backup Administrator, Veeam Restore Operator.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID.
    

     
    restoreSessionId
    required
    string <uuid> 
    Restore session ID.
    

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

     
    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/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId}/stop
    Request samples 
    Response samples 
    application/json
    { }