This is an archive version of the document. To get the most up-to-date information, see the current version.

(GET) /backupTaskSessions/{ID}

On This Page

Request
Response
Example

Returns a resource representation of a task having the specified ID. The parent backup job for the task is created and run on the Veeam backup server connected to Veeam Backup Enterprise Manager.

Request

To get a task having the specified ID, you need to send the GET HTTP request to the URL of the /backupTaskSessions/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/backupTaskSessions/{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
UID	URN	ID of the backup task session.	True	True
Name	String	Name of the backup task session, for example: dc-hv@2013-08-25 05:01:09.	True	True
CreationTime	DateTime	Date and time when the backup task session was launched. The parameter accepts only UTC-formatted DateTime values.	True	True
EndTime	DateTime	Date and time when the backup task session was completed. The parameter accepts only UTC-formatted DateTime values.	True	True
State	String	State of the backup task session. Possible values: InProgress Pending Completed	True	True
Result	String	Result of the backup task session. Possible values: Success Warning Failed	True	True
Reason	String	Reason for which the backup task session has been completed with the Warning or Failed result.	True	True
TotalSize	Long	Size of all restore points produced by the corresponding backup job.	True	True
JobSessionUid	URN	ID of the backup job session parent to the backup task session resource.	True	True
JobUid	URN	ID of the backup job parent to the backup task session resource.	True	True
JobName	String	Name of the backup job parent to the backup task session resource.	True	True
BackupServerUid	URN	ID of the backup server on which the corresponding backup job is created.	True	True
BackupServerName	String	Name of the backup server on which the corresponding backup job is created.	True	True
VmDisplayName	String	Name of the VM that is processed in the backup task session.	True	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 /backupTaskSessions/{ID} resource.

Example

The example request below returns a resource representation of a task having ID 88767486-89d6-4340-92f0-2ad615a8f21b.

Request:

GET http://localhost:9399/api/backupTaskSessions/88767486-89d6-4340-92f0-2ad615a8f21b

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

200 Success

Response Body: