Veeam Backup for AWS 9
REST API Reference
Related documents

File-Level Recovery

The /flrOperations resource collection represents a set of requests used to restore individual files and folders of an EC2 instance to the original location. To learn how to use the set of requests, see the Veeam Backup for AWS REST API Reference How To, section Performing EC2 File-Level Recovery.

Browse Files and Folders of EC2 Instance

The HTTP POST request to the /api/v1/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 AWS REST API.

query Parameters
Offset
integer <int32> >= 0

Excludes from a response the first N items of a resource collection. The default value is 0.

Limit
integer <int32> >= 0

Specifies the maximum number of items of a resource collection to return in a response. The default value is 200.

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
path
required
string

Specifies a path to the directory on the EC2 instance whose items will be returned in the response.

Responses
200

OK

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/flr/{flrSessionId}/browse
Request samples
application/json
{
  • "path": "string"
}
Response samples
{
  • "count": 0,
  • "results": [
    ]
}

Start Searching Through Files and Folders of EC2 Instance

The HTTP POST request to the /api/v1/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 AWS REST API.

query Parameters
searchPattern
required
string

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

traverse
required
boolean

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

Limit
integer <int32> >= 0

Specifies the maximum number of items of a resource collection to return in a response. The default value is 200.

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
path
string

Specifies a path to the directory on the EC2 instance where the items you want to search are located.

Responses
200

OK

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/flr/{flrSessionId}/search/start
Request samples
application/json
{
  • "path": "string"
}
Response samples
{
  • "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9"
}

Get Search Results

The HTTP GET request to the /api/v1/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 AWS REST API.

searchTaskId
required
string <uuid>

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

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

get/api/v1/flr/{flrSessionId}/search/{searchTaskId}/results
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/flr/{flrSessionId}/search/{searchTaskId}/results' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample

Continue Search Task

The HTTP POST request to the /api/v1/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 AWS REST API.

searchTaskId
required
string <uuid>

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

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
202

Accepted

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/flr/{flrSessionId}/search/{searchTaskId}/nextPage
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/flr/{flrSessionId}/search/{searchTaskId}/nextPage' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample

Stop Search Task

The HTTP POST request to the /api/v1/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 AWS REST API.

searchTaskId
required
string <uuid>

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

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
202

Accepted

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/flr/{flrSessionId}/search/{searchTaskId}/stop
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/flr/{flrSessionId}/search/{searchTaskId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample

Perform Restore of Files and Folders

The HTTP POST request to the /api/v1/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 AWS REST API.

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

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

Specifies a lits of paths to the items you want to restore.

restoreType
required
string (FlrRestoreType)

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

Enum: "Overwrite" "Keep"
alternativePath
string

Specifies an alternative path to the directory to which the items will be restored if the original directory no longer exists.

Responses
200

OK

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

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

Get Restore Task Status

The HTTP GET request to the /api/v1/flr/{restoreTaskId}/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 AWS REST API.

restoreTaskId
required
string <uuid>

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

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

get/api/v1/flr/{flrSessionId}/restore/{restoreTaskId}/status
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/flr/{flrSessionId}/restore/{restoreTaskId}/status' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample

Get Restore Logs

The HTTP GET request to the /api/v1/flr/{flrSessionId}/restore/{restoreTaskId}/logs allows you to get a 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 AWS REST API.

restoreTaskId
required
string <uuid>

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

query Parameters
path
required
string

Specifies a path to the restored items.

Offset
integer <int32> >= 0

Excludes from a response the first N items of a resource collection. The default value is 0.

Limit
integer <int32> >= 0

Specifies the maximum number of items of a resource collection to return in a response. The default value is 200.

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

get/api/v1/flr/{flrSessionId}/restore/{restoreTaskId}/logs
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/flr/{flrSessionId}/restore/{restoreTaskId}/logs?path=string&Offset=0&Limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample

Stop Restore Task

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

NOTE
To stop the FLR session, send the HTTP POST request to the Stop Session Processing endpoint.

SecurityBearer
Request
path Parameters
flrSessionId
required
string <uuid>

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

restoreTaskId
required
string <uuid>

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

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

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
202

Accepted

400

Bad Request. 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 a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/flr/{flrSessionId}/restore/{restoreTaskId}/stop
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/flr/{flrSessionId}/restore/{restoreTaskId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample