Queries
Some of the Veeam Backup Enterprise Manager resources support request query parameters. Using query, you can:
- Perform ad-hoc search for necessary resources
- Filter results by defined criteria
- Define the format of results (type of the resource representation), sorting options, and pagination
|
Tip |
|
To learn what query parameters are available for a specific resource, see the Query Parameters section in the GET HTTP method description of the resource. For example, GET /backupServers/{ID}. |
In Veeam Backup Enterprise Manager REST API, the query component is added to the base URL. The query string has the following format:
|
https://<Enterprise-Manager>:9398/api/query?type=<QueryType>[&ParamName=ParamValue] |
where:
- http://<EnterpriseManager>:9399/api/ is the base URL for Veeam Backup Enterprise Manager REST API.
- query? identifies the beginning of the query string. The query? element is added to the base URL.
- type=<QueryType> defines the resource type for which the query is executed, for example, type=BackupServer or type=Job.
For details, see Type Parameter.
- [&ParamName=ParamValue]contains filter parameters passed to the query, for example, format=entities.
For details, see Optional Parameters.