Pagination

To increase readability and optimize network traffic, the Veeam Service Provider Console REST API applies pagination to a number of responses that contain array of values. Operations that return responses with pagination are marked with the x-veeam-pagination: true extension in the specification.

Pagination data is returned in the pagingInfo subsection of the meta section of a response and includes the following properties:

  • total — total number of resources returned.
  • count — number of resources on the current page. The default value is 100. You can modify this number using the limit parameter.
  • offset — number of resources skipped. You can skip resources using the offset parameter.

Pagination Note:

If the number of resources in a collection changes, some resources can move from one page to another.

By default, the maximum number of elements on a page that you can set using the limit parameter is limited to 500. To increase that number:

  1. On the Veeam Service Provider Console server, go to the \Veeam\Availablity Console\Web UI directory and open the appsettings.json file.
  2. In the MaxPageSize parameter value, specify the desired maximum number of resources on a page.

Note that the maximum value is 2147483647.

To apply changes, do one of the following:

  • In Task Manager, end the Veeam.AC.WebUI task.
  • In Internet Information Services, recycle the Veeam Service Provider Console Web UI application pool.

Page updated 12/21/2023

Page content applies to build 8.1.0.21999