Skip to content

List hostnames in an organization

GET
/api/organizations/{organizationId}/hostnames

Returns a flat, paginated collection of every hostname in the organization - both zone-owned and redirect-owned - across all of its domains. Supports filtering by hostname name, zone, owner type and CDN status. Paginated at 30 items per page.

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

organizationId*

Organization identifier

Type
string
Required

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
30
Minimum
0
Maximum
100
q

Search by hostname name (LIKE %q%).

Type
string
zone

Filter by zone id.

Type
integer
ownerType

Filter by owner type.

Type
string
Valid values
"zone""redirect"
cdnEnabled

Filter by CDN status.

Type
boolean

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
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI