Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

(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.

Request

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

HTTP Request

GET http://<Enterprise-Manager>:9399/api/backupSessions/{ID}/taskSessions

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.

Accept

False

The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

Request Body

None.

Query Parameters

None.

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. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /backupSessions/{ID}/taskSessions resource.

Example

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

Request:

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

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<?xml version="1.0" encoding="utf-8"?>
<EntityReferences xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Ref UID="urn:veeam:BackupTaskSession:2007feec-790c-49c3-b116-c4ed3b70ddf0" Name="restapizip@2019-01-17 19:13:29" Href="http://localhost:9399/api/backupTaskSessions/2007feec-790c-49c3-b116-c4ed3b70ddf0" Type="BackupTaskSessionReference">
   <Links>
     <Link Href="http://localhost:9399/api/backupServers/4ad6fa62-9164-4ea0-87c8-1e2d071d60de" Name="restapivbr.qahv1.veeam.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://localhost:9399/api/backupSessions/34b45e89-f138-4539-99a6-224e913582d9" Name="restapizip_2019-01-17T201315@2019-01-17 19:13:15" Type="BackupJobSessionReference" Rel="Up"/>
     <Link Href="http://localhost:9399/api/backupTaskSessions/2007feec-790c-49c3-b116-c4ed3b70ddf0?format=Entity" Name="restapizip@2019-01-17 19:13:29" Type="BackupTaskSession" Rel="Alternate"/>
   </Links>
 </Ref>
</EntityReferences>

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation