This is an archive version of the document. To get the most up-to-date information, see the current version.Query String Options
Veeam Availability Console RESTful API supports querying according to OData protocol. System and Custom Query Options are query string parameters you can specify to control the amount and order of data that Veeam Availability Console RESTful API returns for a resource or collection.
Veeam Availability Console RESTful API supports the following Query Options:
- Filter System Query Option ($filter)
- Orderby System Query Option ($orderby)
- Top System Query Option ($top)
- Skip System Query Option ($skip)
- Select System Query Option ($select)
- Format System Query Option ($format)
- SetLinks Custom Query Option (setLinks)
Veeam Availability Console RESTful API resource properties can be used as query parameters. For example, to order backup repositories by capacity, use the capacity property of the /backupRepositories/{ID} resource as a parameter for the $orderby query option in the following request:
GET https://<Availability-Console>:1281/v2/backupRepositories?$orderby=capacity |
To learn more about properties of a specific resource, see section Properties in the resource reference.