Returns a resource representation of a backup file with the specified ID. The backup file is created on or imported to the Veeam backup server connected to Veeam Backup Enterprise Manager.
Request
To get a backup file, you need to send the GET HTTP request to the URL of the /backupFiles/{ID} resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/backupFiles/{ID} |
or
GET http://<Enterprise-Manager>:9399/api/backupFiles/{ID}?format=Entity |
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
The following parameters can be used in queries.
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | URN | ID of the backup file resource, for example: urn:veeam:BackupFile:0874ab95-10e5-4f25-84df-2782ad81f3e5. | True | True |
Name | String | Name of the backup file, for example: Webserver BackupD2016-09-20T175902.vib. | True | True |
CreationTimeUTC | DateTime | Date and time when the backup file was created. The parameter accepts only UTC-formatted DateTime values. | True | True |
BackupSize | Long | Size of the backup file (in bytes). | True | True |
DataSize | Long | Size of the backed-up data (in bytes). | True | True |
CompressRatio | Double | Data compression ratio. | True | True |
FileType | String | Type of the backup file. Possible values:
| True | True |
BackupUid | URN | ID of the VM backup parent to the backup file resource. | True | True |
BackupName | String | Name of the backup parent to the backup file resource. | True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the backup file resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the backup file resource. | True | True |
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/{ID} resource.
Example
The example below returns an entity resource representation of a backup file with ID 6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4:
Request: GET http://localhost:9399/api/backupFiles/6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 Success
Response Body: <BackupFile xmlns="http://www.veeam.com/ent/v1.0" Type="BackupFile" Href="http://localhost:9399/api/backupFiles/6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4?format=Entity" Name="Webserver Backup CopyD2016-09-20T000000.vbk" UID="urn:veeam:BackupFile:6ed26dc7-cc9e-4a89-9226-1ed9996fb1f4"> |
