Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

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://<Availability-Console>:1281/v2/BackupServers?$top=3

Veeam Availability Console 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.

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

GET https://<Availability-Console>: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.

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference