This is an archive version of the document. To get the most up-to-date information, see the current version.

Top System Query Option ($top)

The $top System Query Option is used to include in a response only the first N items of a resource collection.

For example, to show in a response only the first three backup servers from the /BackupServers collection, send the following request:

GET https://<hostname>:1281/v2/backupServers?$top=3

The Veeam Service Provider Console REST API returns resources in the default order based on its own semantics. To sort or filter a collection before selecting top results, use the $orderby or $filter query options.

For example, to return five backup repositories with minimum space available, send the following request:

GET https://<hostname>:1281/v2/backupRepositories?$top=5&$orderby=freeSpace

Note that the $orderby and $filter options are applied before the $top option regardless of their position in the request. That is, a collection is first filtered or ordered, and then the top results are selected.