Offset Parameter

The offset query parameter 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://<hostname>:1280/api/v3/users?offset=3

You can combine the limit and the offset options to request a particular set of items. Note that the offset option is applied before the limit 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 Service Provider Console, send the following request:

GET https://<hostname>:1280/api/v3/infrastructure/backupServers/repositories?offset=1&limit=2

The Veeam Service Provider Console REST API returns resources in the default order based on its own semantics.