Veeam Backup & Replication 13
REST API Reference
Related documents

Backup Browser

The Backup Browser section defines operations that allow you to:

  • 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.

Validate Target Machine Credentials

The HTTP POST request to the /api/v1/restore/flr/{sessionId}/validateCredentials endpoint validates the target machine credentials in a restore session that has the specified sessionId.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.

SecurityBearer
Request
path Parameters
sessionId
required
string <uuid>

Restore session ID. To get the ID, run the Get All File Restore Mount Points request.

header Parameters
x-api-version
required
string
Default: 1.3-rev2

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

Request Body schema: application/json
required
restoreMode
required
string (EFlrRestoreModeType)

Restore mode for file-level restore.

Enum: "OriginalLocation" "Customized"
credentialsId
string <uuid>

ID of a credentials record used to connect to the target machine. If the ID is not specified, Veeam Backup & Replication will try to find credentials for the target machine in the stored credential records.

object (FlrRestoreTargetHostModel)

Target machine. To get an inventory object, run the Get Inventory Objects request.

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/restore/flr/{sessionId}/validateCredentials
Request samples
application/json
{
  • "restoreMode": "OriginalLocation",
  • "credentialsId": "a1b2c3d4-1111-2222-3333-444455556666"
}
Response samples
application/json
{
  • "isSuccessful": false,
  • "message": "Failed to validate Windows FLR guest credentials for target machine. Error: Logon failure: unknown user name or bad password.",
  • "credentialsId": "a1b2c3d4-1111-2222-3333-444455556666"
}

Validate FLR Restore Item Target Path

The HTTP POST request to the /api/v1/restore/flr/{sessionId}/validateRestoreItemTargetPath endpoint checks whether a target path needs to be provided for the specified file-level restore item. Call this endpoint after the target machine credentials have been validated.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.

SecurityBearer
Request
path Parameters
sessionId
required
string <uuid>

Restore session ID. To get the ID, run the Get All File Restore Mount Points request.

header Parameters
x-api-version
required
string
Default: 1.3-rev2

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

Request Body schema: application/json
required
itemPath
required
string

Path to the item to be restored.

isRestoreToOriginal
required
boolean

If true, the item is restored to its original location.

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.

404

Not found. No object was found with the path parameter 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/restore/flr/{sessionId}/validateRestoreItemTargetPath
Request samples
application/json
{
  • "itemPath": "/data/share/reports/Q1.xlsx",
  • "isRestoreToOriginal": true
}
Response samples
application/json
{
  • "isTargetPathNeeded": false,
  • "targetPath": "/data/share/reports/Q1.xlsx"
}

Get All File Restore Mount Points

The HTTP GET request to the /api/v1/backupBrowser/flr endpoint gets an array of all active file restore mount points.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of mount points to skip.

limit
integer <int32>
Default: 200

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 ascending order by the orderColumn parameter.

header Parameters
x-api-version
required
string
Default: 1.3-rev2

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} endpoint gets a file restore mount point that was created by a restore session that has the specified sessionId.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Restore session ID. To get the ID, run the Get All File Restore Mount Points request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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",
  • "restorePointId": "ab3361d3-df80-474d-b23f-ea9a498b9e8c",
  • "mountErrors": [ ],
  • "properties": {
    },
  • "sourceProperties": {
    }
}
Get Restored Files Audit
The HTTP GET request to the /api/v1/backupBrowser/flr/{sessionId}/audit endpoint gets an aggregated view of items restored during a restore session that has the specified sessionId.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Restore session ID. To get the ID, run the Get All File Restore Mount Points request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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}/audit
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}
Browse File System
The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/browse endpoint browses 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 endpoint compares 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 does not 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 endpoint compares 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 File System request.
     
    NOTE
    The operation is allowed for Microsoft Windows machines only.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 does not 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 endpoint creates 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, run the Browse Search Results request. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 "+".
    

     
    disableRecursiveSearch
    boolean
    If true, Veeam Backup & Replication will not search the child folders, only the files in the parent folder.
    

     
    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 endpoint browses search results of a search task that has the specified taskId. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

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

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 endpoint restores file system items (folders, files and links) to the original location.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

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

     
    targetPath
    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}/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,
    • "logs": {
      }
    }
    Restore Files and Folders to Another Location
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/restoreTo endpoint restores file system items (folders, files and links) to another location.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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"  
    required
    object (FlrRestoreTargetHostModel) 
    Target machine. To get an inventory object, run the Get Inventory Objects request.
    

     
    targetPath
    required
    string
    Path to the target folder.
    

     
    credentialsId
    string <uuid> 
    ID of a credentials record used to connect to the target machine.
    

     
    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,
    • "logs": {
      }
    }
    Prepare Files and Folders for Download
    The HTTP POST request to the /api/v1/backupBrowser/flr/{sessionId}/prepareDownload endpoint prepares files and folders for download and packs 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 download 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
    {
    • "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 endpoint downloads a ZIP archive with files and folders of a download task that has the specified taskId. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    taskId
    required
    string <uuid> 
    Download task ID. To get the ID, run the Get All Tasks request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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/flr/{sessionId}/prepareDownload/{taskId}/download
    Request samples 
    Response samples 
    application/json
    {
    • "errorCode": "UnexpectedContent",
    • "message": "One or more request parameters are not valid."
    }
    Download Files and Folders
    The HTTP GET request to the /api/v1/backupBrowser/flr/{sessionId}/prepareDownload/{taskId}/download endpoint downloads a ZIP archive with files and folders of a download task that has the specified taskId. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All File Restore Mount Points request.
    

     
    taskId
    required
    string <uuid> 
    Download task ID. To get the ID, run the Get All Tasks request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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/flr/{sessionId}/prepareDownload/{taskId}/download
    Request samples 
    Response samples 
    application/json
    {
    • "errorCode": "UnexpectedContent",
    • "message": "One or more request parameters are not valid."
    }
    Get All Unstructured Data Mount Points
    The HTTP GET request to the /api/v1/backupBrowser/flr/unstructuredData endpoint gets all or specified active unstructured data mount points.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

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

     
    limit
    integer <int32> 
     Default:  200
    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 ascending order by the orderColumn parameter.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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} endpoint gets an unstructured data mount point that was created by a restore session that has the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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": "b7e1c2d3-4a5f-6789-abcd-ef0123456789",
    • "properties": {
      },
    • "sourceProperties": {
      }
    }
    Browse Unstructured Data File System
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/browse endpoint browses 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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": "/data/share/reports"
    }
    Response samples 
    application/json
    {
    • "path": "/data/share/reports",
    • "items": [
      ],
    • "pagination": {
      }
    }
    Get Restore Points of Unstructured Data File System Item
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/restorePoints endpoint gets an array of restore points available in a restore session that has the specified sessionId. This request helps you find the restore point from which you want to restore file system item.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

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

     
    object (UnstructuredDataFlrBrowseRestorePointsSortingSpec) 
    Sorting options.
    

     
    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}/restorePoints
    Request samples 
    application/json
    {
    • "path": "/data/share/reports/Q1.xlsx"
    }
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Search for Files and Folders in Unstructured Data Mount Point
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/search endpoint creates 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, run the Browse Search Results in Unstructured Data Mount Point request. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 "+".
    

     
    disableRecursiveSearch
    boolean
    If true, Veeam Backup & Replication will not search the child folders, only the files in the parent folder.
    

     
    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 in Unstructured Data Mount Point
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/search/{taskId}/browse endpoint browses search results of a search task that has the specified taskId. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    taskId
    required
    string <uuid> 
    Search task ID. To get the ID, run the Get All Tasks request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 endpoint copies 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

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

     
    isRecursive
    boolean
    If true, all files and folders in the source path are copied recursively.
    

     
    restoreMode
    string (EUnstructuredDataFLRRestoreMode) 
    Restore point settings.
     Use this property if you have specified the unstructuredDataServerId and the backupId properties in the Start File Restore from Unstructured Data Backup request that you used to mount the share. In this case, you provide information about the restore point in this property.
     Do not use this property if you have specified the restorePointId property in the Start File Restore from Unstructured Data Backup request. In this case, Veeam Backup & Replication uses the restore point whose ID you specified.
    

     Enum: "LatestPoint" "Custom"  
    restoreType
    string (EUnstructuredDataFLRRestoreType) 
    Restore type.
    

     Enum: "Overwrite" "Keep" "ChangedOnly"  
    toDateTime
    string <date-time> 
    Date when the restore point was created. Use this property when copying files and folders from an earlier 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. To get the ID, run the Get All Unstructured Data Servers request.
    

     
    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.
    

     
    restorePermissions
    boolean
    If true, Veeam Backup & Replication will restore permissions and security attributes of the backups.
    

     
    object (UnstructuredDataColdStorageRetrievalSettings) 
    Settings for retrieving data from cold storage.
    

     
    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": false,
    • "restoreMode": "LatestPoint",
    • "restoreType": "Overwrite",
    • "unstructuredDataServerId": "2a3b4c5d-6e7f-8091-a2b3-c4d5e6f70819",
    • "path": "/restore/reports",
    • "copyToBackupServer": true,
    • "restorePermissions": 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,
    • "logs": {
      }
    }
    Restore Files and Folders from Unstructured Data Backup
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/restore endpoint restores unstructured data items.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 (EUnstructuredDataFLRRestoreType) 
    Restore type.
    

     Enum: "Overwrite" "Keep" "ChangedOnly"  
    isRecursive
    boolean
    If true, all files and folders in the source path are restored recursively.
    

     
    restoreMode
    string (EUnstructuredDataFLRRestoreMode) 
    Restore point settings.
     Use this property if you have specified the unstructuredDataServerId and the backupId properties in the Start File Restore from Unstructured Data Backup request that you used to mount the share. In this case, you provide information about the restore point in this property.
     Do not use this property if you have specified the restorePointId property in the Start File Restore from Unstructured Data Backup request. In this case, Veeam Backup & Replication uses the restore point whose ID you specified.
    

     Enum: "LatestPoint" "Custom"  
    toDateTime
    string <date-time> 
    Date when the restore point was created. Use this property when restoring files and folders from an earlier restore point (the restoreMode value is Custom).
    

     
    restorePermissions
    boolean
    If true, Veeam Backup & Replication will restore permissions and security attributes of the backups.
    

     
    object (UnstructuredDataColdStorageRetrievalSettings) 
    Settings for retrieving data from cold storage.
    

     
    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}/restore
    Request samples 
    application/json
    {
    • "sourcePath": [
      ],
    • "isRecursive": false,
    • "restoreType": "Overwrite",
    • "restoreMode": "LatestPoint",
    • "restorePermissions": 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,
    • "logs": {
      }
    }
    Prepare Files and Folders for Download from Unstructured Data Backup
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/prepareDownload endpoint prepares files and folders for download and packs them into a ZIP file. In response, a download task is created.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

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

     
    isRecursive
    boolean
    If true, all files and folders in the source path are download recursively.
    

     
    restoreMode
    string (EUnstructuredDataFLRRestoreMode) 
    Restore point settings.
     Use this property if you have specified the unstructuredDataServerId and the backupId properties in the Start File Restore from Unstructured Data Backup request that you used to mount the share. In this case, you provide information about the restore point in this property.
     Do not use this property if you have specified the restorePointId property in the Start File Restore from Unstructured Data Backup request. In this case, Veeam Backup & Replication uses the restore point whose ID you specified.
    

     Enum: "LatestPoint" "Custom"  
    toDateTime
    string <date-time> 
    Date when the restore point was created. Use this property when download files and folders from an earlier restore point (the restoreMode value is Custom).
    

     
    object (UnstructuredDataColdStorageRetrievalSettings) 
    Settings for retrieving data from cold storage.
    

     
    Responses 
    201
    An FlrDownload task has been created to download 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}/prepareDownload
    Request samples 
    application/json
    {
    • "sourcePath": [
      ],
    • "isRecursive": false,
    • "restoreMode": "LatestPoint"
    }
    Response samples 
    application/json
    {
    • "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 GET request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/prepareDownload/{taskId}/download endpoint downloads a ZIP archive with files and folders of a download task that has the specified taskId. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    taskId
    required
    string <uuid> 
    Download task ID. To get the ID, run the Get All Tasks request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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/flr/unstructuredData/{sessionId}/prepareDownload/{taskId}/download
    Request samples 
    Response samples 
    application/json
    {
    • "errorCode": "UnexpectedContent",
    • "message": "One or more request parameters are not valid."
    }
    Compare Attributes of Unstructured Data Backup with Source
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/compareAttributes endpoint compares attributes of unstructured data items from a restore session that has the specified sessionId with attributes of original items.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 does not 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/unstructuredData/{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 of Unstructured Data Backup with Source
    The HTTP POST request to the /api/v1/backupBrowser/flr/unstructuredData/{sessionId}/compareToProduction endpoint compares unstructured data items on the production share with the items available in a restore session that has the specified sessionId. After the comparison completes, check the comparison results using the Browse Unstructured Data File System request.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Unstructured Data Mount Points request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 does not 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/unstructuredData/{sessionId}/compareToProduction
    Request samples 
    application/json
    {
    • "isEnabled": true,
    • "paths": [
      ]
    }
    Response samples 
    application/json
    { }
    Get Mount Points of All Microsoft Entra ID Tenants
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant endpoint gets an array of all active mount points created for all Microsoft Entra ID tenants. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

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

     
    limit
    integer <int32> 
     Default:  200
    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 ascending order by the orderColumn parameter.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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} endpoint gets a Microsoft Entra ID tenant mount point created by a mount session that has the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 endpoint gets 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 from which you want to restore tenant items.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

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

     
    limit
    integer  >= 1 
    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 Protection Scope of Microsoft Entra ID Tenant
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/protectionScope endpoint gets the protection scope of a Microsoft Entra ID tenant for a specific backup. The tenant protection scope defines the types of tenant resources that were backed up. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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/{backupId}/protectionScope
    Request samples 
    Response samples 
    application/json
    {
    • "tenantResources": [
      ]
    }
    Get Microsoft Entra ID Items
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/browse endpoint browses 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 the item type.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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  >= 0 
    Number of items to skip.
    

     
    limit
    integer  >= 1 
    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} endpoint gets a specific Microsoft Entra ID item available in a tenant backup that has the specified backupId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    itemId
    required
    string
    Item ID. To get the ID, run the Get Restore Points of Microsoft Entra ID Tenant request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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" "DeviceConfiguration" "ConditionalAccessPolicy" "OrgContact" "Device"  
    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 endpoint gets restore points that were created for a Microsoft Entra ID item that has the specified itemId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    itemId
    required
    string
    Item ID. To get the ID, run the Get Restore Points of Microsoft Entra ID Tenant request.
    

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

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

     
    limit
    integer  >= 1 
    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 endpoint validates 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, run the Get Restore Points of Microsoft Entra ID Item request.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 endpoint checks if the specified Microsoft Entra ID items from a mounted tenant backup are available in production.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 endpoint generates passwords for Microsoft Entra ID users that you want to restore.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 endpoint restores Microsoft Entra ID items from a mount point with the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 a restore operator that does not have access to pre-saved credentials. To obtain the credentials, use the following requests: 
    1. Obtain a user code: Get User Code for Delegated Restore of Microsoft Entra ID Items.
      2.  
    2. Use the user code to get the credentials ID: Get Credentials for Delegated Restore of Microsoft Entra ID Items.
    

     
    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, run the Generate Microsoft Entra ID User Passwords request.
    

     
    Array of objects (EntraIdTenantRestoreApplicationCertificatesSpec) 
    Array of application certificates.
    

     
    reason
    string
    Reason for restoring Microsoft Entra ID items.
    

     
    referenceRestoreMode
    string (EEntraIdReferenceRestoreMode) 
    Object relation restore mode.
    

     Enum: "Overwrite" "Merge"  
    Responses 
    201
    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 endpoint restores Microsoft Entra ID item properties from a mount point with the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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" "DeviceConfiguration" "ConditionalAccessPolicy" "OrgContact" "Device"  
    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 a restore operator that does not have access to pre-saved credentials. To obtain the credentials, use the following requests: 
    1. Obtain a user code: Get User Code for Delegated Restore of Microsoft Entra ID Items.
      2.  
    2. Use the user code to get the credentials ID: Get Credentials for Delegated Restore of Microsoft Entra ID Items.
    

     
    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, run the Generate Microsoft Entra ID User Passwords request.
    

     
    reason
    string
    Reason for restoring Microsoft Entra ID items.
    

     
    referenceRestoreMode
    string (EEntraIdReferenceRestoreMode) 
    Object relation restore mode.
    

     Enum: "Overwrite" "Merge"  
    Responses 
    201
    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": "c4d5e6f7-0819-2a3b-4c5d-6e7f80912a3b",
    • "restorePointId": "5d6e7f80-1a2b-3c4d-5e6f-708192a3b4c5",
    • "itemId": "user-9f0a3c6d",
    • "itemType": "User",
    • "includedProperties": [
      ],
    • "skipRelationships": false,
    • "skipRecycleBinRestore": false,
    • "skipObjectsIfExist": false,
    • "requestPasswordChangeOnLogon": true,
    • "reason": "Accidental deletion recovery.",
    • "referenceRestoreMode": "Overwrite"
    }
    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 endpoint compares 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 2 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 a Microsoft Entra ID item.
    

     
    itemType
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     Enum: "User" "Group" "AdminUnit" "Role" "Application" "DeviceConfiguration" "ConditionalAccessPolicy" "OrgContact" "Device"  
    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 earlier 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": "user-9f0a3c6d",
    • "itemType": "User",
    • "oldRestorePointId": "5d6e7f80-1a2b-3c4d-5e6f-708192a3b4c5",
    • "newRestorePointId": "6e7f8091-2a3b-4c5d-6e7f-8091a2b3c4d5",
    • "showUnchangedAttributes": false,
    • "reloadCache": false
    }
    Response samples 
    application/json
    {
    • "existsInOldRestorePoint": true,
    • "existsInNewRestorePoint": true,
    • "properties": [
      ],
    • "references": [
      ],
    • "cacheTimestamp": "2026-05-20T10:30:00Z"
    }
    Start Comparing Microsoft Entra ID Item Properties
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/startCompare endpoint starts comparing 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 2 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, run the Get Comparison Results for Microsoft Entra ID Items request. For details on synchronous request, see Compare Microsoft Entra ID Item Properties.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 a Microsoft Entra ID item.
    

     
    itemType
    required
    string (EEntraIdTenantItemType) 
    Item type.
    

     Enum: "User" "Group" "AdminUnit" "Role" "Application" "DeviceConfiguration" "ConditionalAccessPolicy" "OrgContact" "Device"  
    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 earlier 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": "user-9f0a3c6d",
    • "itemType": "User",
    • "oldRestorePointId": "5d6e7f80-1a2b-3c4d-5e6f-708192a3b4c5",
    • "newRestorePointId": "6e7f8091-2a3b-4c5d-6e7f-8091a2b3c4d5",
    • "showUnchangedAttributes": false,
    • "reloadCache": false
    }
    Response samples 
    application/json
    {
    • "compareSessionId": "7f809120-3a4b-5c6d-7e8f-90a1b2c3d4e5"
    }
    Get Comparison Results for Microsoft Entra ID Items
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/compare/{compareSessionId}/result endpoint gets comparison results for Microsoft Entra ID items, initiated by a comparison session with the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    compareSessionId
    required
    string <uuid> 
    Comparison session ID. To get the ID, run the Start Comparing Microsoft Entra ID Item Properties request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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": "Success",
    • "result": {
      }
    }
    Start Comparing Microsoft Entra ID Conditional Access Policy
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/startRecursiveCompare endpoint starts a recursive comparison of the properties of a Microsoft Entra ID Conditional Access policy available in a mount session that has the specified sessionId.
    You can compare item properties either between 2 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, run the Get Comparison Results for Microsoft Entra ID Conditional Access Policy request. 
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 a Conditional Access policy.
    

     
    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 earlier 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}/startRecursiveCompare
    Request samples 
    application/json
    {
    • "itemId": "group-1a2b3c4d",
    • "oldRestorePointId": "5d6e7f80-1a2b-3c4d-5e6f-708192a3b4c5",
    • "newRestorePointId": "6e7f8091-2a3b-4c5d-6e7f-8091a2b3c4d5",
    • "showUnchangedAttributes": false,
    • "reloadCache": false
    }
    Response samples 
    application/json
    {
    • "compareSessionId": "8091a2b3-4c5d-6e7f-8091-a2b3c4d5e6f7"
    }
    Get Comparison Results for Microsoft Entra ID Conditional Access Policy
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/recursiveCompare/{compareSessionId}/result endpoint gets comparison results for a Microsoft Entra ID Conditional Access policy, initiated by a comparison session with the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    compareSessionId
    required
    string <uuid> 
    Comparison session ID. To get the ID, run the Start Comparing Microsoft Entra ID Conditional Access Policy request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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}/recursiveCompare/{compareSessionId}/result
    Request samples 
    Response samples 
    application/json
    {
    • "status": "Success",
    • "result": {
      }
    }
    Start Exporting Microsoft Entra ID Items to JSON
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/exportToJson endpoint starts exporting Microsoft Entra ID items to JSON files in the mount session that has the specified sessionId. The request is asynchronous: it returns an export session immediately so the client can continue execution, and the export results can be retrieved later when the session changes its state to Success. To get the export results, send the Get JSON Export Results for Microsoft Entra ID Items request.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

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

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 (StartEntraIdTenantExportToJsonRequestItem) 
    Array of objects to export.
    

     
    reason
    string
    Reason for export.
    

     
    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}/exportToJson
    Request samples 
    application/json
    {
    • "items": [
      ],
    • "reason": "Audit export."
    }
    Response samples 
    application/json
    {
    • "exportSessionId": "a2b3c4d5-6e7f-8091-a2b3-c4d5e6f70819"
    }
    Get JSON Export Results for Microsoft Entra ID Items
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/exportToJson/{exportSessionId}/result endpoint gets the JSON export results from an export session that has the specified exportSessionId within a mount session that has the specified sessionId. The response contains a SAS URI that you can use to download the exported JSON files.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

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

     
    exportSessionId
    required
    string <uuid> 
    Export session ID.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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}/exportToJson/{exportSessionId}/result
    Request samples 
    Response samples 
    application/json
    {}
    Export Microsoft Entra ID Tenant Objects To JSON
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/exportToJsonDownload endpoint exports Microsoft Entra ID tenant objects to JSON.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 (EntraIdTenantExportToJsonDownloadRequestItem) 
    Array of Microsoft Entra ID items to export to JSON.
    

     
    reason
    string
    Reason for the export.
    

     
    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.
    

    post/api/v1/backupBrowser/entraIdTenant/{sessionId}/exportToJsonDownload
    Request samples 
    application/json
    {
    • "items": [
      ],
    • "reason": "Audit export."
    }
    Response samples 
    application/json
    {
    • "errorCode": "AccessDenied",
    • "message": "Unauthorized. Get bearer JWT token at /api/login"
    }
    Export Microsoft Entra ID Items
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/export endpoint exports Microsoft Entra ID items from a 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    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.3-rev2
    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  >= 0 
    Number of items to skip.
    

     
    limit
    integer  >= 1 
    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": "UnexpectedContent",
    • "message": "One or more request parameters are not valid."
    }
    Upload Microsoft Entra ID Users
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadUser endpoint uploads a CSV file and gets 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
    Comma-separated list of user IDs. For users, you can also specify a list of user principal 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 endpoint uploads a CSV file and gets 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
    Comma-separated list of group 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/{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 endpoint uploads a CSV file and gets 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
    Comma-separated list of administrative unit 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/{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 endpoint uploads a CSV file and gets 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
    Comma-separated list of role 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/{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 endpoint 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: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
    Comma-separated list of application 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/{backupId}/uploadApplication
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Conditional Access Policies
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadConditionalAccessPolicy endpoint allows you to upload a CSV file and get an array of conditional access policies, 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 Conditional Access policies.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
     
    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}/uploadConditionalAccessPolicy
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Device Configurations
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadDeviceConfiguration endpoint uploads a CSV file and gets an array of device configurations, 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 Device configurations.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
     
    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}/uploadDeviceConfiguration
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Organization Contacts
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadOrgContact endpoint uploads a CSV file and gets an array of organization contacts that 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 organization contacts.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
    Comma-separated list of organization contact 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/{backupId}/uploadOrgContact
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Upload Microsoft Entra ID Devices
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{backupId}/uploadDevice endpoint uploads a CSV file and gets an array of devices that 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 devices.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    backupId
    required
    string <uuid> 
    Backup ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/octet-stream
    required
    string <binary> 
    Comma-separated list of device 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/{backupId}/uploadDevice
    Request samples 
    Response samples 
    application/json
    {
    • "data": [
      ],
    • "pagination": {
      }
    }
    Get All Restore Sessions of Microsoft Entra ID Tenant
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreSessions endpoint gets an array of restore sessions that were started for a Microsoft Entra ID tenant mount point with the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    query Parameters
    skip
    integer <int32> 
    Number of items to skip.
    

     
    limit
    integer <int32> 
     Default:  200
    Maximum number of items to return.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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 GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId} endpoint gets a restore session that has the specified restoreSessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    restoreSessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Restore Sessions of Microsoft Entra ID Tenant request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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
    {
    • "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"
    }
    Get Restore Session Logs of Microsoft Entra ID Tenant
    The HTTP GET request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId}/logs endpoint gets restore session logs of a Microsoft Entra ID tenant.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    restoreSessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Restore Sessions of Microsoft Entra ID Tenant request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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": 1,
    • "records": [
      ]
    }
    Stop Restore Session of Microsoft Entra ID Tenant
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/restoreSessions/{restoreSessionId}/stop endpoint stops a restore session of a Microsoft Entra ID tenant.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

     
    restoreSessionId
    required
    string <uuid> 
    Restore session ID. To get the ID, run the Get All Restore Sessions of Microsoft Entra ID Tenant request.
    

     
    header Parameters
    x-api-version
    required
    string
     Default:  1.3-rev2
    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
    { }
    Reveal Microsoft Entra ID BitLocker Recovery Key
    The HTTP POST request to the /api/v1/backupBrowser/entraIdTenant/{sessionId}/revealBitlockerRecoveryKey endpoint reveals the BitLocker recovery key for a device specified in the request body, in a mount session that has the specified sessionId.
    Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
    

    SecurityBearer 
    Request 
    path Parameters
    sessionId
    required
    string <uuid> 
    Mount session ID. To get the ID, run the Get Mount Points of All Microsoft Entra ID Tenants request.
    

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

     
    Request Body schema: application/json
    required
    deviceId
    required
    string
    Infrastructure ID of the device.
    

     
    restorePointId
    string <uuid> 
    Restore point ID.
    

     
    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}/revealBitlockerRecoveryKey
    Request samples 
    application/json
    {
    • "restorePointId": "5d6e7f80-1a2b-3c4d-5e6f-708192a3b4c5",
    • "deviceId": "device-7e8b1a45"
    }
    Response samples 
    application/json
    {
    • "bitlockerRecoveryKeys": [
      ]
    }