List hostnames in a zone
GET
/api/zones/{zoneId}/hostnames
Returns the hostnames attached to the given zone, optionally filtered by name.
Authorizations
ApiToken
Long-lived API token created via POST /api/api-tokens (returned once in plaintext).
Type
API Key (header: X-API-TOKEN)
or
JWT
JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer
Type
HTTP (bearer)
Parameters
Path Parameters
zoneId*
Zone identifier
Type
Requiredstring
Query Parameters
page
The collection page number
Type
integer
Default
1itemsPerPage
The number of items per page
Type
integer
Default
30Minimum
0Maximum
100name
Filter by hostname name (partial, case-insensitive match).
Type
string
name[]
Filter by hostname name (partial, case-insensitive match).
Type
array
Responses
hostname collection
JSON "totalItems": 0, "search": { "@type": "string", "template": "string", "variableRepresentation": "string", "mapping": [ { "@type": "string", "variable": "string", "property": "string", "required": true } ] }, "view": { "@id": "string", "@type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" }, "member": [ { "@context": "string", "@id": "string", "@type": "string", "id": "9f1b2c3d-4e5f-6789-abcd-ef0123456789", "domain": "https://example.com/", "zone": "https://example.com/", "redirect": "https://example.com/", "name": "www.example.com", "cnameTarget": "string", "cdnEnabled": false, "dnsTargetStatus": "pending", "dnsObservedValue": "string", "dnsLastCheckedAt": "2026-07-01T12:00:00+00:00", "createdAt": "2026-07-01T12:00:00+00:00", "updatedAt": "2026-07-01T12:00:00+00:00", "sharedCertificate": false } ]
{
}