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

Skip System Query Option ($skip)

The $skip System Query Option is used to exclude from a response the first N items of a resource collection.

For example, to show in a response all users starting from the forth one, send the following request:

GET https://<Availability-Console>:1281/v2/Users?$skip=3

You can combine the $top and the $skip options to request a particular set of items. Note that the $skip option is applied before the $top option, regardless of its position in the request. That is, top results are selected from a collection where a set of items is already excluded.

For example, to return the second and the third backup repositories available in Veeam Availability Console, send the following request:

GET https://<Availability-Console>:1281/v2/BackupRepositories?$skip=1&$top=2

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 the second and the third largest backup repositories available in Veeam Availability Console, send the following request:

GET https://<Availability-Console>:1281/v2/BackupRepositories?$skip=1&$top=2&$orderby=capacity

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

Veeam Large Logo

Deployment Guide

Migration Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Evaluator's Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Evaluator's Guide for Enterprises

RESTful API Reference