Paginated collections#

To reduce load on the service, retrieve operations return a maximum limit of 100 items at a time. If a request supplies no limit or one that exceeds the configured default limit, the default limit is used instead.

This behavior is called pagination. Pagination gives you the ability to limit the size of the returned data and to retrieve a specified subset of a large data set. Pagination has two key concepts: limit and marker.

Limit is the restriction on the maximum number of items for that type that can be returned.
Marker is a reference to an object's ID and is in the list of paged results for a particular resource. For example, if the resource is a load balancer, the marker is the load balancer ID at which to begin the list of the paged results.

To navigate the collection, you can set the limit and marker parameters in the URI. For example, ?limit=10&marker=1234 displays a maximum of 10 domains in the paginated results, beginning with the domain with an id of 1234.

If a marker beyond the end of a list is given, an empty list is returned.

You can also use the offset parameter, which is a count of the number of objects from where the paginated list is started.

It is important to note that offset must be a multiple of the limit (or zero), otherwise a Bad Request Exception will be thrown. Both limit and offset are specified via request parameters on the URI. The parameters are named limit and offset respectively, and both apply only to GET calls. If unspecified, they default to limit=100 and offset=0. See the examples that follow.

Examples of limits and offsets for paging calls

....\domains?limit=50              -- returns the first 50 domains, that is: 1 - 50
....\domains?limit=50&offset=50    -- returns the domains 51-100
....\domains?limit=25&offset=50    -- returns the domains 51-75
....\domains?limit=25              -- returns the domains 1-25
....\domains?limit=25&offset=5     -- returns Bad Request Exception; offset must be a multiple of the limit or 0
....\domains?offset=5              -- returns Bad Request Exception; offset must be a multiple of the limit or 0
....\domains?offset=200            -- returns back the 201-300th domains if they exist (default limit of 100 applies)
....\domains                       -- returns the current maximum items allowable (currently 100)

Pagination applies only to the calls listed here:

Verb	URI	Description
GET	/domains/	List all domains manageable by the account specified.
GET	/domains/?name=domainName	Filter domains by domain name: list all domains manageable by the account specified that match the name domainName.
GET	/domains/domainID	List details of the specified domain. Applies to the recordsand subdomains lists.
GET	/domains/domainID/subdomains	List domains that are subdomains of the specified domain.
GET	/domains/domainID/records	List all records configured for the domain.

See the following section for examples of paged List Domains calls.

Paginated collections#

Pagination elements and attributes#