Add a delegated or purchased domain
POST /v1/admin/orgs/{org_id}/domains
POST
/v1/admin/orgs/{org_id}/domains
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” org_id
required
string
Request Body required
Section titled “Request Body required ”object
domain
required
string
mode
required
string
Responses
Section titled “ Responses ”Connected; returns the nameserver records for delegated setup.
object
domain
string
mode
string
verification_status
string
zone_id
string
provisioning_phase
string
provisioning_error
string
delegation_ns
Array<object>
A DNS record the customer must add for domain onboarding.
object
name
string
type
string
Example
TXT value
string
priority
integer
ttl
integer
records
Array<object>
A DNS record the customer must add for domain onboarding.
object
name
string
type
string
Example
TXT value
string
priority
integer
ttl
integer
instruction
string
Invalid request.
The canonical error envelope. error is a stable machine code.
object
error
required
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
string
Example
forbidden message
Human-readable detail (never leaks internals).
string
Example
missing required scopeMissing or invalid credential.
The canonical error envelope. error is a stable machine code.
object
error
required
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
string
Example
forbidden message
Human-readable detail (never leaks internals).
string
Example
missing required scope