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

Path Parameters

id
string
required

The domain's ID.

Query Parameters

capability
enum<string>

Verify only this capability instead of every capability configured on the domain.

Available options:
web,
email_sending,
email_receiving

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
site_id
object
required
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
verified_at
string<date-time> | null