This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /repositories/{ID}
Returns a resource representation of a backup repository having the specified ID. The backup repository is created on the Veeam backup server connected to Veeam Backup Enterprise Manager.
Request
To get a backup repository, you need to send the GET HTTP request to the URL of the /repositories/{ID} resource.
HTTP Request
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. |
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.
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 repository resource, for example: urn: veeam:Repository:b609c947-dd30-4295-8b57-cc880329dbd6. | True | True |
Name | String | Name of the backup repository, for example: Backups Vol2. | True | True |
FreeSpace | Int64 | Free space available on the backup repository. | True | True |
Capacity | Int64 | Total space available on the backup repository. | True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the backup repository resource, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the backup repository resource. for example: BACKUPSERVER. | True | True |
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, Veeam Backup Enterprise Manager returns a representation of the /repositories/{ID} resource.
Example
The example below returns a backup repository having ID bffeb9f5-1bdd-4bbd-9299-6fcb7c37bdf6.
Request: GET https://localhost:9398/api/repositories/bffeb9f5-1bdd-4bbd-9299-6fcb7c37bdf6
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <Repository xmlns="http://www.veeam.com/ent/v1.0" Type="Repository" Href="https://localhost:9398/api/repositories/bffeb9f5-1bdd-4bbd-9299-6fcb7c37bdf6?format=Entity" Name="Backup Volume 01" UID="urn:veeam:Repository:bffeb9f5-1bdd-4bbd-9299-6fcb7c37bdf6"> |
