GET /backups/{ID}
Returns a resource representation of a backup having the specified ID. The backup is created on or imported to the backup server connected to Veeam Backup Enterprise Manager.
Supported Platforms
The request is supported for the following platforms:
- VMware vSphere
- VMware Cloud Director
- Microsoft Hyper-V
Request
To get a backup, send the GET HTTP request to the URL of the /backups/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/backups/{ID} |
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. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
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. Possible values:
|
Response Body
In the response body, the REST API returns an entity or an entity reference of the /backups/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
---|---|---|
UID | UidType | UID of the backup resource, for example: urn:veeam:Backup:58c917c7-7b7a-41ff-8676-226656c35c05. |
Name | String | Name of the backup job parent to the backup, for example: SQL Backup. |
Platform | String | Type of a platform of a backup resource. Possible values:
|
String | Type of a backup resource. Possible values:
|
To view query parameters that you can use for filtering or sorting, see GET /query?type=Backup.
Links
Reference | Relationship | Description |
---|---|---|
/repositories/{ID} | Up | URL of the /repositories/{ID} resource — a repository where the backup is stored. |
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource parent to the backup. |
/backups/{ID} | Alternate | Alternate URL of the /backups/{ID} resource. |
/backups/{ID}/restorePoints | Down | URL of the /restorePoints resource — a collection of restore points contained in the backup. |
/backups/{ID}/backupFiles | Down | URL of the /backupFiles resource — a collection of backup files contained in the backup. |
Example
The example below returns an entity resource representation of a backup having ID 2e734096-56ea-4f36-ac2a-15546518d26c:
Request: GET https://enterprise04.tech.local:9398/api/backups/2e734096-56ea-4f36-ac2a-15546518d26c?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <?xml version="1.0" encoding="utf-8"?> |