object: "custom_domain". The same shape is used for create, get, list, and the domain field embedded in the verify response.
Example
Identifiers
string
required
Always
"custom_domain".string (uuid)
required
Stable UUID. Use it in
/custom-domains/{id} and as the domain_id foreign key on routes.string
required
The hostname. Lowercased and trimmed on write.
www.<apex> inputs are canonicalised to the apex form — www.acme.com becomes acme.com, and www is auto-paired as a redirect.Verification
boolean
required
Convenience boolean:
true when verified_at is non-null.string (datetime) | null
required
When the domain became live. Null while DNS is still propagating or if the customer hasn’t published the records yet.
string (datetime) | null
required
Most recent verification attempt. Updated by both the automatic poll and manual
POST /custom-domains/{id}/verify calls.string | null
required
Human-readable reason the last check failed, if any. Cleared on the next successful verify.
array
required
DNS records the customer must publish to prove ownership and route traffic. The array is empty once the domain is verified.
Timestamps
string (datetime)
required
When the domain was connected. ISO 8601.
Delete behaviour
DELETE /custom-domains/{id} returns 204 No Content. The hostname is disconnected from the TLS terminator, the row is removed, and the billable add-on slot is released. Every custom_domain_route attached to the domain is removed by the database FK cascade — there is no soft-delete.