Veeam Backup & Replication 13
REST API Reference
Related documents

Tasks

The Tasks section defines paths and operations for managing tasks that are used to perform runtime operations (file restore and rescan of inventory objects).

Get All Tasks

The HTTP GET request to the /api/v1/tasks path allows you to get an array of restore tasks performed on the backup server.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of tasks to skip.

limit
integer <int32>
Default: 200

Maximum number of tasks to return.

orderColumn
string (ETaskFiltersOrderColumn)

Sorts tasks by one of the session parameters.

Enum: "Name" "Type" "CreationTime" "EndTime" "State" "Result"
orderAsc
boolean

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

nameFilter
string

Filters tasks by the nameFilter pattern. The pattern can match any task parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

createdAfterFilter
string <date-time>

Returns tasks that are created after the specified date and time.

createdBeforeFilter
string <date-time>

Returns tasks that are created before the specified date and time.

endedAfterFilter
string <date-time>

Returns tasks that are finished after the specified date and time.

endedBeforeFilter
string <date-time>

Returns tasks that are finished before the specified date and time.

typeFilter
string (ETaskType)

Filters tasks by task type.

Enum: "Common" "FlrRestore" "FlrDownload" "FlrSearch" "HierarchyRescan" "DeploymentKit"
stateFilter
string (ETaskState)

Filters tasks by task state.

Enum: "Starting" "Working" "Stopping" "Stopped"
resultFilter
string (ETaskResult)

Filters tasks by task result.

Enum: "None" "Success" "Warning" "Failed" "Cancelled"
header Parameters
x-api-version
required
string
Default: 1.3-rev0

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

Responses
200

OK

401

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

403

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

500

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

get/api/v1/tasks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Task
The HTTP GET request to the /api/v1/tasks/{id} path allows you to get a restore task that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Task ID. To get the ID, run the Get All Tasks request.


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


 
Responses 
200
OK


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


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


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.


get/api/v1/tasks/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Common",
  • "name": "string",
  • "state": "Starting",
  • "progressPercent": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "result": "None",
  • "additionalInfo": {
    }
}
Stop Task
The HTTP POST request to the /api/v1/tasks/{id}/stop path allows you to stop a restore task that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Task ID. To get the ID, run the Get All Tasks request.


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


 
Responses 
200
OK


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


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


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/tasks/{id}/stop
Request samples 
Response samples 
application/json
{ }