Skip to content

Get one domain's detail and nameserver records

GET
/v1/admin/orgs/{org_id}/domains/{domain}

Read one onboarded domain the caller’s org owns, including the DNS nameserver records the customer must publish for ns_delegated mode. The list endpoint omits records to stay lightweight, so the console reads this when a domain row is expanded so the delegation reappears after the onboarding dialog is dismissed or the page reloaded. Tenant-scoped: an unknown domain, or one owned by a different org, is a 404 (records are never leaked across tenants).

org_id
required
string
domain
required
string

The domain detail with delegation_ns inline.

object
domain
string
mode
string
Allowed values: shared ns_delegated manual purchased
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
nullable
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
nullable
ttl
integer
instruction
string

Missing 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

Resource not found.

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