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}.

Query Syntax

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:

For details, see Type Parameter.

  • [&ParamName=ParamValue]contains filter parameters passed to the query, for example, format=entities.

For details, see Optional Parameters.