This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /tasks/{ID}
Returns a resource representation of a task having the specified ID. The task is created by Veeam Backup Enterprise Manager in response to client requests.
Request
To get a task session, you need to send the GET HTTP request to the URL of the /tasks/{ID} resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/tasks/{ID} |
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. To learn more, see Authentication and Security. |
Request Body
None.
Query Parameters
The following parameters can be used in queries.
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
TaskUid | String | ID of the task resource, for example: task-1. | False | True |
State | String | State of the task operation. Possible values:
| False | True |
Operation | String | Name of the task operation, for example: StartJob. | False | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 Success.
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: application/xml. |
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /tasks/{ID} resource.
Example
The example below returns a task having ID task-30.
Request: GET http://localhost:9399/api/tasks/task-30
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 Success
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-30"> |