GET /query?type=Repository
Returns a resource representation of the collection of backup repositories created on backup servers connected to Veeam Backup Enterprise Manager. For details, see /repositories.
Request
To get a list of repositories, send the GET HTTP request to the query with the type parameter set to Repository.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/query?type=Repository |
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.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
Parameter | Type | Description |
|---|---|---|
UID | UidType | UID of the backup repository resource, for example: urn: veeam:Repository:b609c947-dd30-4295-8b57-cc880329dbd6. |
Name | String | Name of the backup repository, for example: Backups Vol2. |
FreeSpace | Int64 | Free space available on the backup repository. |
Capacity | Int64 | Total space available on the backup repository. |
BackupServerUid | UidType | UID of the backup server parent to the backup repository resource, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15. |
BackupServerName | String | Name of the backup server parent to the backup repository resource. for example: BACKUPSERVER. |
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 a representation of the /repositories resource collection.
Example
The example below returns an entity resource representation of a collection of backup repositories that have less than 100 GB of free space.
Request: GET https://localhost:9398/api/query?type=Repository&format=Entities&filter=FreeSpace<107374182400
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |