Get one domain's detail, status, and nameserver records

GET

/v1/domains/{domain}

• Production
• Local

Fetch one of the customer’s domains: its verification/DKIM status and the nameserver records to publish for delegated setup (delegation_ns). Tenant-scoped: another customer’s (or an unknown) domain is a 404.

Authorizations

• AgentKey
  domain:manage

Parameters

Path Parameters

domain

required

string

The fully-qualified domain name (e.g. mail.acme.com).

Responses

200

Ok

The agent-facing view of one domain: its status plus the nameserver records the customer must publish for delegated setup. Records are empty on list reads and for hosted/purchased modes.

object

id

string

domain

string

mode

string

Allowed values: shared ns_delegated manual purchased

verification_status

string

dkim_status

string

shared

boolean

provisioning_phase

string

provisioning_error

string

created_at

string format: date-time

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

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

instruction

string

401

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

403

Authenticated but lacking the required scope, or out of quota.

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

404

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