Chapter 7. Using pagination in the API

Procedure

1. Request the page given by the "next" sequential URL, to get to the next page.

2. Use the page_size=XX query string parameter to change the number of results returned for each request.

   • The page_size has a default maximum limit of 200, which is enforced when a user tries a value beyond it, for example, ?page_size=1000. However, you can change this limit by setting the value in /etc/tower/conf.d/<some file>.py to something higher. For example, MAX_PAGE_SIZE=1000.

3. Use the page query string parameter to retrieve a particular page of results:

   http://<gateway server name>/api/controller/v2/model_verbose_name?page_size=100&page=2

   Copy to Clipboard Toggle word wrap
   Note

   The preceding and following links returned with the results set these query string parameters automatically.

   Do not request page sizes greater than 200.

   The user interface uses smaller values to avoid scrolling.