5.6. Using Searches with Pagination Control
You can use the per_page
and page
pagination parameters to limit the search results that an API search query returns. The per_page
parameter specifies the number of results per page and the page
parameter specifies which page, as calculated by the per_page
parameter, to return.
The default number of items to return is set to 1000 when you do not specify any pagination parameters, but the per_page
value has a default of 20 which applies when you specify the page
parameter.
Listing Content Views
This example returns a list of Content Views in pages. The list contains 10 keys per page and returns the third page.
Example request:
curl --request GET --user sat_username:sat_password \ https://satellite.example.com/katello/api/content_views?per_page=10&page=3
$ curl --request GET --user sat_username:sat_password \
https://satellite.example.com/katello/api/content_views?per_page=10&page=3
Listing Activation Keys
This example returns a list of activation keys for an organization with ID 1
in pages. The list contains 30 keys per page and returns the second page.
Example request:
curl --request GET --user sat_username:sat_password \ https://satellite.example.com/katello/api/activation_keys?organization_id=1&per_page=30&page=2
$ curl --request GET --user sat_username:sat_password \
https://satellite.example.com/katello/api/activation_keys?organization_id=1&per_page=30&page=2
Returning Multiple Pages
You can use a for
loop structure to get multiple pages of results.
This example returns pages 1 to 3 of Content Views with 5 results per page:
for i in seq 1 3; do \ curl --request GET --user sat_username:sat_password \ https://satellite.example.com/katello/api/content_views?per_page=5&page=$i; \ done
$ for i in seq 1 3; do \
curl --request GET --user sat_username:sat_password \
https://satellite.example.com/katello/api/content_views?per_page=5&page=$i; \
done