List hostnames in a zone
Returns the hostnames attached to the given zone, ordered by name ascending unless an order parameter is given. Filterable by name, DNS target status and CDN status.
Authorizations
Long-lived API token created via POST /api/api-tokens (returned once in plaintext). A token created with readOnly may only perform safe requests (GET, HEAD, OPTIONS); write requests are rejected on every endpoint.
JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer
Parameters
Path Parameters
Zone identifier
Query Parameters
The collection page number
1The number of items per page
300100Filter by hostname name (partial, case-insensitive match).
Filter by hostname name (partial, case-insensitive match).
Filter by DNS target status (exact): pending, valid, degraded, invalid or proxied. Repeat as dnsTargetStatus[] to match any of several statuses.
Filter by DNS target status (exact): pending, valid, degraded, invalid or proxied. Repeat as dnsTargetStatus[] to match any of several statuses.
Filter by CDN status: true = CDN enabled only, false = CDN disabled only, omit for all.
Sort by DNS target status, alphabetically by its value (asc or desc).
"asc""desc""ASC""DESC"Sort by DNS target status, alphabetically by its value (asc or desc).
Sort by CDN status (asc = disabled first, desc = enabled first).
"asc""desc""ASC""DESC"Sort by CDN status (asc = disabled first, desc = enabled first).
Sort by hostname name (asc or desc). Default: asc.
"asc""desc""ASC""DESC"Sort by hostname name (asc or desc). Default: asc.
Responses
hostname collection