GET /query?type=Task
Returns a resource representation of a collection of tasks created by Veeam Backup Enterprise Manager within the currently existing logon session. For details, see /tasks.
Request
To get a list of tasks, send the GET HTTP request to the query with the type parameter set to Task.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/query?type=Task |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values: - application/xml — the client can send this value in the header to accept response in the XML format.
- application/json — the client must send this value in the header to accept the request in the JSON format.
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
Parameter | Type | Description |
|---|
TaskId | String | ID of the task resource, for example: task-1. |
State | String | State of the task. Possible values: - Running — the task is in progress.
- OperationFinished — the task operation is finished on the backup server, but Veeam Backup Enterprise Manager has not collected the operation data yet.
- Finished — the task operation is finished, and the Veeam Backup Enterprise Manager database contains the operation data.
|
Operation | String | Name of the task operation, for example: StartJob. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values: - application/xml
- application/json
|
Response Body
In the response body, the REST API returns a representation of the /tasks resource collection.
Example
The example below returns a collection of finished tasks created by Veeam Backup Enterprise Manager.
Request: GET https://localhost:9398/api/query?type=Task&filter=State==Finished Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0">
<Resources>
<Tasks>
<Task Type="Task" Href="https://localhost:9398/api/tasks/task-5">
<Links>
<Link Rel="Delete" Href="https://localhost:9398/api/tasks/task-5" />
<Link Rel="Related" Type="BackupJobSession" Href="https://localhost:9398/api/backupSessions/35c24055-bdee-4e43-b655-a42de408d2ec?format=Entity" />
</Links>
<TaskId>task-5</TaskId>
<State>Finished</State>
<Operation>StartJob</Operation>
<Result Success="true">
<Message>Ok</Message>
</Result>
</Task>
<Task Type="Task" Href="https://localhost:9398/api/tasks/task-6">
<Links>
<Link Rel="Delete" Href="https://localhost:9398/api/tasks/task-6" />
<Link Rel="Related" Type="ReplicaJobSession" Href="https://localhost:9398/api/replicaSessions/16f8d8af-5b13-43e7-8109-c46e17a0a53f?format=Entity" />
</Links>
<TaskId>task-6</TaskId>
<State>Finished</State>
<Operation>StartJob</Operation>
<Result Success="true">
<Message>Ok</Message>
</Result>
</Task>
<Task Type="Task" Href="https://localhost:9398/api/tasks/task-7">
<Links>
<Link Rel="Delete" Href="https://localhost:9398/api/tasks/task-7" />
<Link Rel="Related" Type="Job" Href="https://localhost:9398/api/jobs/b0d7b298-3bbc-4e01-8a78-068cb98b5412?format=Entity" Name="Cloned job (6/5/2021 3:04:23 AM)" />
</Links>
<TaskId>task-7</TaskId>
<State>Finished</State>
<Operation>CloneJob</Operation>
<Result Success="true">
<Message>OK</Message>
</Result>
</Task>
</Tasks>
</Resources>
<PagingInfo PagesCount="1" PageSize="15" PageNum="1">
<Links>
<Link Rel="First" Href="https://localhost:9398/api/query?type=Task&pageSize=15&page=1" />
<Link Rel="Last" Href="https://localhost:9398/api/query?type=Task&pageSize=15&page=1" />
</Links>
</PagingInfo>
</QueryResult> |