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

/backups

Represents a collection of all backups created on or imported to Veeam backup servers connected to Veeam Backup Enterprise Manager.

Resource URL

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

Related Resources

/backups/{ID}

Methods

The following methods are supported for the /backups resource:

(GET) /backups

Resource Representation

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

<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:Backup:80f01823-4b57-47a5-b6d8-0a2259f08ccb" Name="GDPR Backup" Href="http://local.host:9399/api/backups/80f01823-4b57-47a5-b6d8-0a2259f08ccb" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/9b5baa77-bfe9-4f1a-bf54-f277803f5304" Name="LocalRepo" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/80f01823-4b57-47a5-b6d8-0a2259f08ccb?format=Entity" Name="GDPR Backup" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/80f01823-4b57-47a5-b6d8-0a2259f08ccb/restorePoints" Type="RestorePointReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:Backup:5d6cf99f-e1ba-42c7-87e8-0ac82d80bba3" Name="hv_restore" Href="http://local.host:9399/api/backups/5d6cf99f-e1ba-42c7-87e8-0ac82d80bba3" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/9b5baa77-bfe9-4f1a-bf54-f277803f5304" Name="LocalRepo" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/5d6cf99f-e1ba-42c7-87e8-0ac82d80bba3?format=Entity" Name="hv_restore" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/5d6cf99f-e1ba-42c7-87e8-0ac82d80bba3/restorePoints" Type="RestorePointReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:Backup:437a5792-b83e-4fa7-ac14-0f5d7b9a4ead" Name="Agent Backup rhel72 lvm" Href="http://local.host:9399/api/backups/437a5792-b83e-4fa7-ac14-0f5d7b9a4ead" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/44f0b2ba-9bff-4cd0-8d34-5b11e5d17fe9" Name="Scale-out Backup Repository" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/437a5792-b83e-4fa7-ac14-0f5d7b9a4ead?format=Entity" Name="Agent Backup rhel72 lvm" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/437a5792-b83e-4fa7-ac14-0f5d7b9a4ead/childbackups" Type="BackupReferenceList" Rel="Up"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:Backup:5d053fdf-34cd-4db5-9c72-13de4f1646d4" Name="starwind-gate-n2_restored Backup (Some VMs)" Href="http://local.host:9399/api/backups/5d053fdf-34cd-4db5-9c72-13de4f1646d4" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/9b5baa77-bfe9-4f1a-bf54-f277803f5304" Name="LocalRepo" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/5d053fdf-34cd-4db5-9c72-13de4f1646d4?format=Entity" Name="starwind-gate-n2_restored Backup (Some VMs)" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/5d053fdf-34cd-4db5-9c72-13de4f1646d4/restorePoints" Type="RestorePointReferenceList" Rel="Down"/>
     <Link Href="http://local.host:9399/api/backups/459f0d10-9674-428f-8d83-6b71c2d8a6ec" Name="Parent Backup" Type="BackupReference" Rel="Up"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:Backup:c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70" Name="Simple backup_1" Href="http://local.host:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/9b5baa77-bfe9-4f1a-bf54-f277803f5304" Name="LocalRepo" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70?format=Entity" Name="Simple backup_1" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70/childbackups" Type="BackupReferenceList" Rel="Up"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:Backup:e556fda9-07e1-4f49-9193-42d255a909ca" Name="VM number 0 Backup (Simple backup_1)" Href="http://local.host:9399/api/backups/e556fda9-07e1-4f49-9193-42d255a909ca" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/9b5baa77-bfe9-4f1a-bf54-f277803f5304" Name="LocalRepo" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/e556fda9-07e1-4f49-9193-42d255a909ca?format=Entity" Name="VM number 0 Backup (Simple backup_1)" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/e556fda9-07e1-4f49-9193-42d255a909ca/restorePoints" Type="RestorePointReferenceList" Rel="Down"/>
     <Link Href="http://local.host:9399/api/backups/c213fbfa-7b9e-4772-9ddc-3ecbdcc3fc70" Name="Parent Backup" Type="BackupReference" Rel="Up"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:Backup:1929d5e3-9122-4845-85ce-46b1d4e83608" Name="test_restored301118T1409_2018-12-14T184310" Href="http://local.host:9399/api/backups/1929d5e3-9122-4845-85ce-46b1d4e83608" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/72e80cc0-07c7-49a4-812f-22bc44551563" Name="debian79" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/1929d5e3-9122-4845-85ce-46b1d4e83608?format=Entity" Name="test_restored301118T1409_2018-12-14T184310" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/1929d5e3-9122-4845-85ce-46b1d4e83608/restorePoints" Type="RestorePointReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:Backup:4ffe55d9-e431-4825-91e1-4a6ad404b5d6" Name="Agent Backup Policy 1 - at-win7x86.local" Href="http://local.host:9399/api/backups/4ffe55d9-e431-4825-91e1-4a6ad404b5d6" Type="BackupReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="srv02.veeam.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/repositories/44f0b2ba-9bff-4cd0-8d34-5b11e5d17fe9" Name="Scale-out Backup Repository" Type="RepositoryReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/backups/4ffe55d9-e431-4825-91e1-4a6ad404b5d6?format=Entity" Name="Agent Backup Policy 1 - at-win7x86.local" Type="Backup" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/backups/4ffe55d9-e431-4825-91e1-4a6ad404b5d6/restorePoints" Type="RestorePointReferenceList" Rel="Down"/>
     <Link Href="http://local.host:9399/api/backups/f3c4a08c-f589-4c56-bd94-34705e91c40e" Name="Parent Backup" Type="BackupReference" Rel="Up"/>
   </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