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 return only the first three failover plans in the /FailoverPlans collection, send the following request:

GET https://uwin2012r2.n.local:9899/v1/FailoverPlans?$top=3

VAO RESTful 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. 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.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.