GET /backupSessions/{ID}/taskSessions

Returns a resource representation of a collection of all task sessions performed with the Backup and Agent type backup job sessions with a specified ID. Note, the request only returns the sessions that has been created for the last 30 days.

Supported Platforms

The request is supported for the following platforms:

  • VMware vSphere
  • VMware Cloud Director
  • Microsoft Hyper-V
  • Veeam Agent computers running Microsoft Windows or Linux


To get a list of all task sessions for Backup and Agent backup sessions, send the GET HTTP request to the URL of the /backupSessions/{ID}/taskSessions resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/backupSessions/{ID}/taskSessions

Request Headers

The request contains the following headers:






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.



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



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.




The length of the response body.


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 /backupSessions/{ID}/taskSessions resource.


The example below returns a list of task sessions performed during a backup session with an ID 8ba90554-4cb0-4979-b4cc-00887fcd1caa.


GET https://localhost:9398/api/backupSessions/8ba90554-4cb0-4979-b4cc-00887fcd1caa/taskSessions


Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj



200 OK


Response Body:

<?xml version="1.0" encoding="utf-8"?>
<EntityReferences xmlns="" xmlns:xsd="" xmlns:xsi="">
 <Ref UID="urn:veeam:BackupTaskSession:2007feec-790c-49c3-b116-c4ed3b70ddf0" Name="restapizip@2019-01-17 19:13:29" Href="https://localhost:9398/api/backupTaskSessions/2007feec-790c-49c3-b116-c4ed3b70ddf0" Type="BackupTaskSessionReference">
     <Link Href="https://localhost:9398/api/backupServers/4ad6fa62-9164-4ea0-87c8-1e2d071d60de" Name="" Type="BackupServerReference" Rel="Up"/>
     <Link Href="https://localhost:9398/api/backupSessions/34b45e89-f138-4539-99a6-224e913582d9" Name="restapizip_2019-01-17T201315@2019-01-17 19:13:15" Type="BackupJobSessionReference" Rel="Up"/>
     <Link Href="https://localhost:9398/api/backupTaskSessions/2007feec-790c-49c3-b116-c4ed3b70ddf0?format=Entity" Name="restapizip@2019-01-17 19:13:29" Type="BackupTaskSession" Rel="Alternate"/>

Page updated 3/4/2024

Page content applies to build