Skip to main content
GET
Get domain

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

domain_id
string<uuid>
required

Response

Domain retrieved successfully

Detailed domain response.

domain_id
string<uuid>
required

Domain ID

domain_name
string
required

Domain name

status
string
required

Domain status

stalwart_added
boolean
required

Whether added to Stalwart

cloudflare_verified
boolean
required

Whether Cloudflare is verified

max_inboxes
integer
required

Maximum inboxes allowed

current_inboxes
integer
required

Current inbox count

aggregate_health_score
number
required

Average health score of all inboxes on this domain (0-100). 100.0 if no inboxes.

created_at
string
required

Creation timestamp

nameservers
string[] | null

Nameservers to use

dns_records
DomainDNSRecord · object[] | null

DNS records to configure

updated_at
string | null

Last update timestamp