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

/backupSessions

Represents a list of all backup job sessions performed on all Veeam backup servers connected to Veeam Backup Enterprise Manager.

Resource URL

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

Related Resources

/backupSessions/{ID}

Methods

The following methods are supported for the /backupSessions resource:

(GET) /backupSessions

Resource Representation

The /backupSessions resource has a resource representation of the following type:

<EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
 <Ref Type="BackupJobSessionReference" Href="http://localhost:9399/api/backupSessions/d2b8d33e-32b5-43be-9d72-02b5d8b290d0" Name="Fileserver Backup@2014-10-19 07:32:44" UID="urn:veeam:BackupJobSession:d2b8d33e-32b5-43be-9d72-02b5d8b290d0">
   <Links>
     <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
     <Link Rel="Up" Type="JobReference" Href="http://localhost:9399/api/jobs/4856ab37-2235-45e8-affe-d515878b01a9" Name="Fileserver Backup" />
     <Link Rel="Alternate" Type="BackupJobSession" Href="http://localhost:9399/api/backupSessions/d2b8d33e-32b5-43be-9d72-02b5d8b290d0?format=Entity" Name="Fileserver Backup@2014-10-19 07:32:44" />
     <Link Rel="Down" Type="BackupTaskSessionReferenceList" Href="http://localhost:9399/api/backupSessions/d2b8d33e-32b5-43be-9d72-02b5d8b290d0/taskSessions" />
   </Links>
 </Ref>
 <Ref Type="BackupJobSessionReference" Href="http://localhost:9399/api/backupSessions/bce9741f-d6aa-43ca-a229-1706c2eea0e7" Name="vApp 01 Backup Job@2014-10-19 06:05:03" UID="urn:veeam:BackupJobSession:bce9741f-d6aa-43ca-a229-1706c2eea0e7">
   <Links>
     <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
     <Link Rel="Up" Type="JobReference" Href="http://localhost:9399/api/jobs/b41fdf6f-9adc-473d-8086-6fc6e17117d0" Name="vApp 01 Backup Job" />
     <Link Rel="Alternate" Type="BackupJobSession" Href="http://localhost:9399/api/backupSessions/bce9741f-d6aa-43ca-a229-1706c2eea0e7?format=Entity" Name="vApp 01 Backup Job@2014-10-19 06:05:03" />
     <Link Rel="Down" Type="BackupTaskSessionReferenceList" Href="http://localhost:9399/api/backupSessions/bce9741f-d6aa-43ca-a229-1706c2eea0e7/taskSessions" />
   </Links>
 </Ref>
 <Ref Type="BackupJobSessionReference" Href="http://localhost:9399/api/backupSessions/6d0faaea-9e99-4aec-8135-317cc0415602" Name="Fileserver Backup@2014-10-18 15:22:16" UID="urn:veeam:BackupJobSession:6d0faaea-9e99-4aec-8135-317cc0415602">
   <Links>
     <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
     <Link Rel="Up" Type="JobReference" Href="http://localhost:9399/api/jobs/4856ab37-2235-45e8-affe-d515878b01a9" Name="Fileserver Backup" />
     <Link Rel="Alternate" Type="BackupJobSession" Href="http://localhost:9399/api/backupSessions/6d0faaea-9e99-4aec-8135-317cc0415602?format=Entity" Name="Fileserver Backup@2014-10-18 15:22:16" />
     <Link Rel="Down" Type="BackupTaskSessionReferenceList" Href="http://localhost:9399/api/backupSessions/6d0faaea-9e99-4aec-8135-317cc0415602/taskSessions" />
   </Links>
 </Ref>
 <Ref Type="BackupJobSessionReference" Href="http://localhost:9399/api/backupSessions/4dcc1993-c7e8-4e4d-a82b-48716dd148a2" Name="Oracle Backup@2014-10-18 13:09:06" UID="urn:veeam:BackupJobSession:4dcc1993-c7e8-4e4d-a82b-48716dd148a2">
   <Links>
     <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
     <Link Rel="Up" Type="JobReference" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720" Name="Oracle Backup" />
     <Link Rel="Alternate" Type="BackupJobSession" Href="http://localhost:9399/api/backupSessions/4dcc1993-c7e8-4e4d-a82b-48716dd148a2?format=Entity" Name="Oracle Backup@2014-10-18 13:09:06" />
     <Link Rel="Down" Type="BackupTaskSessionReferenceList" Href="http://localhost:9399/api/backupSessions/4dcc1993-c7e8-4e4d-a82b-48716dd148a2/taskSessions" />
   </Links>
 </Ref>
 <Ref Type="BackupJobSessionReference" Href="http://localhost:9399/api/backupSessions/8738ca5c-bda0-44cf-973d-6d46175d7522" Name="Daily NetApp Snapshots@2016-01-01 18:10:30" UID="urn:veeam:BackupJobSession:8738ca5c-bda0-44cf-973d-6d46175d7522">
   <Links>
     <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
     <Link Rel="Up" Type="JobReference" Href="http://localhost:9399/api/jobs/62638c60-74b6-4d6d-8d13-4cd32039f522" Name="Daily NetApp Snapshots" />
     <Link Rel="Alternate" Type="BackupJobSession" Href="http://localhost:9399/api/backupSessions/8738ca5c-bda0-44cf-973d-6d46175d7522?format=Entity" Name="Daily NetApp Snapshots@2016-01-01 18:10:30" />
     <Link Rel="Down" Type="BackupTaskSessionReferenceList" Href="http://localhost:9399/api/backupSessions/8738ca5c-bda0-44cf-973d-6d46175d7522/taskSessions" />
   </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