Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
name
string
required
site_id
string
page
string

Slug of a public published page to serve at this hostname. A gated page can't be served on a custom domain, and a hostname serves either a site or one page.

pages
boolean

Serve every published page of the account at https:///, members-only ones included: viewers sign in on the hostname and each page keeps its own access. One pages domain per account; it cannot also serve a site or a single page.

capabilities
object

Response

Domain

object
string
required
id
string
required
domain
string
required
purchase_status
enum<string> | null
required
Available options:
pending_payment,
registering,
registered,
failed,
null
auto_renew
boolean | null
required

Whether the registration renews itself before expires_at; null for a domain connected rather than bought here. Change it with PATCH auto_renew.

site_id
object
required
page
string | null
required
pages
boolean
required

True when the domain serves every published page of the account at https:///.

managed_zone
boolean
required
zone_id
object
required
capabilities
object
required
records
object
required
next_step
object
required
created_at
string<date-time>
required
verification_errors
string[]
required
expires_at
string<date-time> | null
verified_at
string<date-time> | null