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

(GET) /agents/backupSessions

Returns a resource representation of a collection of sessions performed for Veeam Agent backup jobs configured in Veeam Backup & Replication on all Veeam backup servers connected to Veeam Backup Enterprise Manager. Veeam Agent backup job sessions are also displayed in the representation of the /backupSessions resource collection.

Request

To get a list of sessions performed for Veeam Agent backup jobs configured in Veeam Backup & Replication, you need to send the GET HTTP request to the URL of the /agents/backupSessions resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/agents/backupSessions

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 /agents/backupSessions resource.

Example

The example below returns a list of sessions for Veeam Agent backup jobs configured in Veeam Backup & Replication on all Veeam backup servers connected to Veeam Backup Enterprise Manager.

Request:

GET http://localhost:9399/api/agents/backupSessions

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<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:BackupJobSession:8ba90554-4cb0-4979-b4cc-00887fcd1caa" Name="Agent Backup Job SQL@2018-12-20 14:30:29" Href="http://w10x64v1709.local:9399/api/backupSessions/8ba90554-4cb0-4979-b4cc-00887fcd1caa" Type="BackupJobSessionReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/8c88c6d6-931f-4044-8c0b-7a0c5f188b00" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/95f84a48-6e05-459a-8f26-f2330c9efdf5" Name="Agent Backup Job SQL" Type="JobReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupSessions/8ba90554-4cb0-4979-b4cc-00887fcd1caa/agentManagementSessions" Type="BackupJobSessionReferenceList" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/8ba90554-4cb0-4979-b4cc-00887fcd1caa?format=Entity" Name="Agent Backup Job SQL@2018-12-20 14:30:29" Type="BackupJobSession" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/8ba90554-4cb0-4979-b4cc-00887fcd1caa/taskSessions" Type="BackupTaskSessionReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:BackupJobSession:fc98d417-63c6-432e-8378-017eb33b51f3" Name="Agent Backup rhel72 lvm@2018-12-16 05:00:00" Href="http://local.host:9399/api/backupSessions/fc98d417-63c6-432e-8378-017eb33b51f3" Type="BackupJobSessionReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/8c88c6d6-931f-4044-8c0b-7a0c5f188b00" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/4dc5d947-9c23-4e1b-976a-ee5911f6a996" Name="Agent Backup rhel72 lvm" Type="JobReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupSessions/fc98d417-63c6-432e-8378-017eb33b51f3/agentManagementSessions" Type="BackupJobSessionReferenceList" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/fc98d417-63c6-432e-8378-017eb33b51f3?format=Entity" Name="Agent Backup rhel72 lvm@2018-12-16 05:00:00" Type="BackupJobSession" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/fc98d417-63c6-432e-8378-017eb33b51f3/taskSessions" Type="BackupTaskSessionReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:BackupJobSession:b0b3b4d5-fcfd-429c-928f-01a52ddfe560" Name="Agent Backup rhel72 lvm - rhel72@2018-12-16 10:00:08" Href="http://local.host:9399/api/backupSessions/b0b3b4d5-fcfd-429c-928f-01a52ddfe560" Type="BackupJobSessionReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/8c88c6d6-931f-4044-8c0b-7a0c5f188b00" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/a1e698f3-282c-484c-b942-e42c5c77449a" Name="Agent Backup rhel72 lvm - rhel72" Type="JobReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupSessions/addf6ac2-89d9-4f5c-b90b-2e63f84ac3da" Name="Parent session" Type="BackupJobSessionReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupSessions/b0b3b4d5-fcfd-429c-928f-01a52ddfe560?format=Entity" Name="Agent Backup rhel72 lvm - rhel72@2018-12-16 10:00:08" Type="BackupJobSession" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/b0b3b4d5-fcfd-429c-928f-01a52ddfe560/taskSessions" Type="BackupTaskSessionReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:BackupJobSession:8293f9f3-7cc8-4023-85c4-022438415420" Name="Agent Backup Job SQL@2018-12-16 03:00:03" Href="http://local.host:9399/api/backupSessions/8293f9f3-7cc8-4023-85c4-022438415420" Type="BackupJobSessionReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/8c88c6d6-931f-4044-8c0b-7a0c5f188b00" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/95f84a48-6e05-459a-8f26-f2330c9efdf5" Name="Agent Backup Job SQL" Type="JobReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupSessions/8293f9f3-7cc8-4023-85c4-022438415420/agentManagementSessions" Type="BackupJobSessionReferenceList" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/8293f9f3-7cc8-4023-85c4-022438415420?format=Entity" Name="Agent Backup Job SQL@2018-12-16 03:00:03" Type="BackupJobSession" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/8293f9f3-7cc8-4023-85c4-022438415420/taskSessions" Type="BackupTaskSessionReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:BackupJobSession:1e036782-9084-42e5-97c5-0230250a1bd4" Name="Agent Backup rhel72 lvm - rhel72@2018-12-16 08:00:16" Href="http://local.host:9399/api/backupSessions/1e036782-9084-42e5-97c5-0230250a1bd4" Type="BackupJobSessionReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/8c88c6d6-931f-4044-8c0b-7a0c5f188b00" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/a1e698f3-282c-484c-b942-e42c5c77449a" Name="Agent Backup rhel72 lvm - rhel72" Type="JobReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupSessions/3b4fd6a2-bda4-422c-a0a0-c2ae1a8ce5cd" Name="Parent session" Type="BackupJobSessionReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backupSessions/1e036782-9084-42e5-97c5-0230250a1bd4?format=Entity" Name="Agent Backup rhel72 lvm - rhel72@2018-12-16 08:00:16" Type="BackupJobSession" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backupSessions/1e036782-9084-42e5-97c5-0230250a1bd4/taskSessions" Type="BackupTaskSessionReferenceList" Rel="Down"/>
   </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 Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation