Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

File-Level Recovery

The /flr resource collection represents a set of requests used to restore individual files and folders of an Azure VM to the original location.

Browse Files and Folders of Azure VM

The HTTP POST request to the /api/v8/flr/{flrSessionId}/browse endpoint allows you to browse files and folders in an FLR session with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

query Parameters
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Request Body schema: application/json
required
path
string

Specifies the absolute path to the Azure VM whose files and folders are restored by the FLR session. Note: Relative paths are not allowed.

Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

post/api/v8/flr/{flrSessionId}/browse
Request samples
application/json
{
  • "path": "string"
}
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Start Searching Through Files and Folders of Azure VM

The HTTP POST request to the /api/v8/flr/{flrSessionId}/search/start endpoint allows you to start searching through files and folders in an FLR session with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
path
string

Specifies the absolute path to the directory on the Azure VM whose items will be returned in the response. Note: Relative paths are not allowed.

limit
integer or null <int32> >= 1

Specifies the maximum number of items of a resource collection to return in a response.

traverse
boolean

Defines whether the search must be performed through all subdirectories and nested elements.

searchPattern
string

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

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

404

Not Found

post/api/v8/flr/{flrSessionId}/search/start
Request samples
application/json
{
  • "path": "string",
  • "limit": 1,
  • "traverse": true,
  • "searchPattern": "string"
}
Response samples
application/json
{
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9"
}

Get Search Results

The HTTP GET request to the /api/v8/flr/{flrSessionId}/search/{searchTaskId}/results endpoint allows you to retrieve the results of a search task with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

searchTaskId
required
string <uuid>

Specifies the system ID assigned to a search task in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

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

404

Not Found

get/api/v8/flr/{flrSessionId}/search/{searchTaskId}/results
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/flr/{flrSessionId}/search/{searchTaskId}/results' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "searchState": "Preparing",
  • "count": 0,
  • "results": [
    ]
}

Continue Search Task

The HTTP POST request to the /api/v8/flr/{flrSessionId}/search/{searchTaskId}/nextPage endpoint allows you to continue the search task with the specified ID.

NOTE
To view the results of the continued search, send the HTTP GET request to the Get Search Results endpoint.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

searchTaskId
required
string <uuid>

Specifies the system ID assigned to a search task in the Veeam Backup for Microsoft Azure REST API.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

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

404

Not Found

post/api/v8/flr/{flrSessionId}/search/{searchTaskId}/nextPage
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/flr/{flrSessionId}/search/{searchTaskId}/nextPage' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Stop Search Task

The HTTP POST request to the /api/v8/flr/{flrSessionId}/search/{searchTaskId}/stop endpoint allows you to stop a search task with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

searchTaskId
required
string <uuid>

Specifies the system ID assigned to a search task in the Veeam Backup for Microsoft Azure REST API.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

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

404

Not Found

post/api/v8/flr/{flrSessionId}/search/{searchTaskId}/stop
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/flr/{flrSessionId}/search/{searchTaskId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Restore Files and Folders

The HTTP POST request to the /api/v8/flr/{flrSessionId}/restore endpoint allows you to restore specific items from an FLR session with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
itemPaths
Array of strings

Specifies a list of absolute paths to the items you want to restore. Note: Relative paths are not allowed.

restoreType
string (FlrSessionRestoreType)

Defines whether you want to download a copy of the items or to restore the original items.

Enum: "Overwrite" "Keep"
alternativePath
string or null

Specifies an alternative path to the directory to which the items will be restored if the original directory no longer exists. Note: Relative paths are not allowed.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

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

404

Not Found

post/api/v8/flr/{flrSessionId}/restore
Request samples
application/json
{
  • "itemPaths": [
    ],
  • "restoreType": "Overwrite",
  • "alternativePath": "string"
}
Response samples
application/json
{
  • "restoreTaskId": "2d5b0ff8-fdc7-4bd2-8a6a-7bba05a78484"
}

Get Restore Task Status

The HTTP GET request to the /api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/status endpoint allows you to retrieve the results of a restore task with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

restoreTaskId
required
string <uuid>

Specifies the system ID assigned to a restore task in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

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

404

Not Found

get/api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/status
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/status' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "restoreTaskId": "2d5b0ff8-fdc7-4bd2-8a6a-7bba05a78484",
  • "results": [
    ]
}

Get Restore Logs

The HTTP GET request to the /api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/logs endpoint allows you to retrieve detailed logs for each item processed by a restore task with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

restoreTaskId
required
string <uuid>

Specifies the system ID assigned to a restore task in the Veeam Backup for Microsoft Azure REST API.

query Parameters
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Request Body schema: application/json
required
path
string

Specifies the absolute path to the restored item. Note: Relative paths are not allowed.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

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

404

Not Found

post/api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/logs
Request samples
application/json
{
  • "path": "string"
}
Response samples
application/json
{
  • "path": "string",
  • "pagination": {
    },
  • "results": [
    ]
}

Stop Restore Task

The HTTP POST request to the /api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/stop endpoint allows you to stop a restore task with the specified ID.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for Microsoft Azure REST API.

restoreTaskId
required
string <uuid>

Specifies the system ID assigned to a restore task in the Veeam Backup for Microsoft Azure REST API.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

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

404

Not Found

post/api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/stop
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/flr/{flrSessionId}/restore/{restoreTaskId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}