This is an archive version of the document. To get the most up-to-date information, see the
current version.
(GET) /backups
Returns a resource representation of a collection of backups created on or imported to Veeam backup servers connected to Veeam Backup Enterprise Manager.
To get a list of backups, you need to send the GET HTTP request to the URL of the /backups resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/backups |
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. |
Request Body
None.
Query Parameters
None.
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: application/xml. |
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /backups resource collection.
The example below returns a list of all backups created on Veeam backup servers connected to Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/backups Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/d5311600-78a5-48d3-8e69-0fed4d3b5744" Name="Oracle Backup" UID="urn:veeam:Backup:d5311600-78a5-48d3-8e69-0fed4d3b5744">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/cbd9a4b6-b9ed-4cd6-a091-75b6481c9d55" Name="Default Backup Repository" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/d5311600-78a5-48d3-8e69-0fed4d3b5744?format=Entity" Name="Oracle Backup" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/d5311600-78a5-48d3-8e69-0fed4d3b5744/restorePoints" />
</Links>
</Ref>
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/ef3bd23f-c284-44bc-abcb-1e03e150f2c6" Name="Webserver Backup" UID="urn:veeam:Backup:ef3bd23f-c284-44bc-abcb-1e03e150f2c6">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/98fbd079-f5ae-48f8-8ec2-e148333fef93" Name="Omega Cloud Vol1" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/ef3bd23f-c284-44bc-abcb-1e03e150f2c6?format=Entity" Name="Webserver Backup" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/ef3bd23f-c284-44bc-abcb-1e03e150f2c6/restorePoints" />
</Links>
</Ref>
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/c19136d3-2eb1-4032-b56f-38ff7e630470" Name="Oracle Backup_imported" UID="urn:veeam:Backup:c19136d3-2eb1-4032-b56f-38ff7e630470">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/cbd9a4b6-b9ed-4cd6-a091-75b6481c9d55" Name="Default Backup Repository" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/c19136d3-2eb1-4032-b56f-38ff7e630470?format=Entity" Name="Oracle Backup_imported" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/c19136d3-2eb1-4032-b56f-38ff7e630470/restorePoints" />
</Links>
</Ref>
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/9db76138-be9e-4784-924d-45524a277936" Name="Microsoft SharePoint Backup" UID="urn:veeam:Backup:9db76138-be9e-4784-924d-45524a277936">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/cbd9a4b6-b9ed-4cd6-a091-75b6481c9d55" Name="Default Backup Repository" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/9db76138-be9e-4784-924d-45524a277936?format=Entity" Name="Microsoft SharePoint Backup" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/9db76138-be9e-4784-924d-45524a277936/restorePoints" />
</Links>
</Ref>
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/76eaa065-a210-466a-bc89-6c68d7d40c20" Name="SQL Backup" UID="urn:veeam:Backup:76eaa065-a210-466a-bc89-6c68d7d40c20">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/bffeb9f5-1bdd-4bbd-9299-6fcb7c37bdf6" Name="Backup Volume 01" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/76eaa065-a210-466a-bc89-6c68d7d40c20?format=Entity" Name="SQL Backup" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/76eaa065-a210-466a-bc89-6c68d7d40c20/restorePoints" />
</Links>
</Ref>
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/9131653c-c632-4666-a28d-7907eb322f87" Name="Microsoft Exchange Backup" UID="urn:veeam:Backup:9131653c-c632-4666-a28d-7907eb322f87">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/cbd9a4b6-b9ed-4cd6-a091-75b6481c9d55" Name="Default Backup Repository" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/9131653c-c632-4666-a28d-7907eb322f87?format=Entity" Name="Microsoft Exchange Backup" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/9131653c-c632-4666-a28d-7907eb322f87/restorePoints" />
</Links>
</Ref>
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/4bb923d9-749d-423b-aa76-a72fda2f2ade" Name="Mediaserver Backup" UID="urn:veeam:Backup:4bb923d9-749d-423b-aa76-a72fda2f2ade">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/734a76ff-bf3b-43bb-bb98-6c74fbf265f9" Name="Omega Cloud Vol2" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/4bb923d9-749d-423b-aa76-a72fda2f2ade?format=Entity" Name="Mediaserver Backup" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/4bb923d9-749d-423b-aa76-a72fda2f2ade/restorePoints" />
</Links>
</Ref>
<Ref Type="BackupReference" Href="http://localhost:9399/api/backups/e8320dcd-b06a-46f9-816c-e4b964ad91c8" Name="Microsoft Active Directory Backup" UID="urn:veeam:Backup:e8320dcd-b06a-46f9-816c-e4b964ad91c8">
<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="RepositoryReference" Href="http://localhost:9399/api/repositories/cbd9a4b6-b9ed-4cd6-a091-75b6481c9d55" Name="Default Backup Repository" />
<Link Rel="Alternate" Type="Backup" Href="http://localhost:9399/api/backups/e8320dcd-b06a-46f9-816c-e4b964ad91c8?format=Entity" Name="Microsoft Active Directory Backup" />
<Link Rel="Down" Type="RestorePointReferenceList" Href="http://localhost:9399/api/backups/e8320dcd-b06a-46f9-816c-e4b964ad91c8/restorePoints" />
</Links>
</Ref>
</EntityReferences> |
