(GET) /backupFiles
Returns a resource representation of a collection of backup files created on or imported to Veeam backup servers connected to Veeam Backup Enterprise Manager.
Request
To get a list of backup files, you need to send the GET HTTP request to the URL of the /backupFiles resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/backupFiles |
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.
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: application/xml. |
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /backupFiles resource collection.
Example
The example below returns a list of all backup files created on Veeam backup servers connected to Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/backupFiles Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="BackupFileReference" Href="http://localhost:9399/api/backupFiles/6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4" Name="Webserver Backup CopyD2016-09-20T000000.vbk" UID="urn:veeam:BackupFile:6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/99f01406-ecdc-428f-ae09-a13de244140a" Name="172.17.53.1" />
<Link Rel="Up" Type="BackupReference" Href="http://localhost:9399/api/backups/80672bda-76a8-408b-947f-afd0ff67fba6" Name="Webserver Backup Copy" />
<Link Rel="Alternate" Type="BackupFile" Href="http://localhost:9399/api/backupFiles/6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4?format=Entity" Name="Webserver Backup CopyD2016-09-20T000000.vbk" />
<Link Rel="Related" Type="BackupFileReferenceList" Href="http://localhost:9399/api/backupFiles/6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4/restorePoints" />
<Link Rel="Down" Type="VmRestorePointReferenceList" Href="http://localhost:9399/api/backupFiles/6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4/vmRestorePoints" />
</Links>
</Ref>
<Ref Type="BackupFileReference" Href="http://localhost:9399/api/backupFiles/0874ab95-10e5-4f25-84df-2782ad81f3e5" Name="Webserver BackupD2016-09-20T175902.vib" UID="urn:veeam:BackupFile:0874ab95-10e5-4f25-84df-2782ad81f3e5">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/99f01406-ecdc-428f-ae09-a13de244140a" Name="172.17.53.1" />
<Link Rel="Up" Type="BackupReference" Href="http://localhost:9399/api/backups/10cf7239-ddbd-47ad-8cfa-15438a5a5467" Name="Webserver Backup" />
<Link Rel="Alternate" Type="BackupFile" Href="http://localhost:9399/api/backupFiles/0874ab95-10e5-4f25-84df-2782ad81f3e5?format=Entity" Name="Webserver BackupD2016-09-20T175902.vib" />
<Link Rel="Related" Type="BackupFileReferenceList" Href="http://localhost:9399/api/backupFiles/0874ab95-10e5-4f25-84df-2782ad81f3e5/restorePoints" />
<Link Rel="Down" Type="VmRestorePointReferenceList" Href="http://localhost:9399/api/backupFiles/0874ab95-10e5-4f25-84df-2782ad81f3e5/vmRestorePoints" />
</Links>
</Ref>
<Ref Type="BackupFileReference" Href="http://localhost:9399/api/backupFiles/312ab2fc-69c5-4bb4-af9b-910064d34313" Name="Webserver BackupD2016-09-20T175525.vbk" UID="urn:veeam:BackupFile:312ab2fc-69c5-4bb4-af9b-910064d34313">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/99f01406-ecdc-428f-ae09-a13de244140a" Name="172.17.53.1" />
<Link Rel="Up" Type="BackupReference" Href="http://localhost:9399/api/backups/10cf7239-ddbd-47ad-8cfa-15438a5a5467" Name="Webserver Backup" />
<Link Rel="Alternate" Type="BackupFile" Href="http://localhost:9399/api/backupFiles/312ab2fc-69c5-4bb4-af9b-910064d34313?format=Entity" Name="Webserver BackupD2016-09-20T175525.vbk" />
<Link Rel="Related" Type="BackupFileReferenceList" Href="http://localhost:9399/api/backupFiles/312ab2fc-69c5-4bb4-af9b-910064d34313/restorePoints" />
<Link Rel="Down" Type="VmRestorePointReferenceList" Href="http://localhost:9399/api/backupFiles/312ab2fc-69c5-4bb4-af9b-910064d34313/vmRestorePoints" />
</Links>
</Ref>
</EntityReferences> |
