Umbrella for Government API, Pagination

Pagination

The Umbrella for Government API endpoints that list the resources in the collection also support pagination.

Admin, Deployments, and Policies

You can set the limit and page request query parameters for the collection endpoints.

If the limit query parameter is not set, Umbrella returns up to 200 records per request. If the page query parameter is not specified, the page value defaults to 1.

Pagination does not apply to the following endpoints:

• api.umbrellagov.com/admin/v2/users
• api.umbrellagov.com/admin/v2/roles
• api.umbrellagov.com/deployments/v2/virtualappliances

Pagination by endpoint:

• api.umbrellagov.com/deployments/v2/networks
  • Maximum batch size is 1000 records
• api.umbrellagov.com/deployments/v2/roamingcomputers
  • Maximum batch size is 200 records
• api.umbrellagov.com/policies/v2/destinationlists/{destinationListId}/destinations
  • Maximum batch size is 100 records

To get another batch size, set the limit query parameter. For example:

curl -L --location-trusted --request GET --url https://api.umbrellagov.com/policies/v2/destinationlists/{destinationListId}/destinations?limit=25 \
-H 'Authorization: Bearer %YourAccessToken%' \
-H 'Content-Type: application/json'

Reports

You can control the number of records in the Umbrella Reporting API response with the limit and offset query parameters.

The Umbrella Reporting API endpoints provide various query parameters to filter and customize requests. For more information, see Umbrella Reporting API Query Parameters.