Sign in

v1

latestOpenAPI 3.1.12026-08-063445179.6 KB
domains

Register a domain

Register a hostname to the authenticated organization. Provide the bare hostname (e.g. acme.com) — never a *. wildcard literal — and use kind to control whether the apex, its wildcard subdomains, or both are served. Returns the verification token and the DNS records the user must publish.

post/v2/domains

Request body

domainstring required

Bare hostname to register, e.g. shop.acme.com — without a *. prefix. Wildcard coverage is selected via kind, not by putting a * label in the hostname.

kind'base_only' | 'wildcard_only' | 'base_and_wildcard'

Response

OK

idstring required

Unique domain identifier (UUID)

organization_idstring required

Organization that owns the domain

domainstring required

The bare hostname (e.g. shop.acme.com). Wildcard coverage is reported via kind, never as a *. literal in this field.

kind'base_only' | 'wildcard_only' | 'base_and_wildcard' required

Whether the domain covers the apex, a wildcard, or both

verification_tokenstring required

Token to publish under _acme-challenge.<domain> for ownership verification

is_validatedboolean required

True once DNS-based ownership has been confirmed

created_atstring required

ISO 8601 timestamp of creation

updated_atstring required

ISO 8601 timestamp of last modification