Skip to main content
GET
Manage Domain

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

路径参数

domain_id
string
必填

域名的 ID。

响应

状态码为 200 的响应

domain_id
string
必填

域名的 ID。

domain
string
必填

域名(例如 example.com)。

status
enum<string>
必填

域名的验证状态。

可用选项:
NOT_STARTED,
PENDING,
INVALID,
FAILED,
VERIFYING,
VERIFIED
feedback_enabled
boolean
必填

退信和投诉通知将发送到您的收件箱。

subdomains_enabled
boolean
必填

Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (*.<domain>) to records.

tracking_enabled
boolean
必填

Serve open tracking pixels from this domain. Adds a required link.<domain> CNAME record to records, which must be published and verified before track_opens can be used on a send.

records
VerificationRecord · object[]
必填

A list of DNS records required to verify the domain. Includes the apex MX record unless inbound_enabled is false, and a wildcard MX record (*.<domain>) when subdomains_enabled is true.

updated_at
string<date-time>
必填

域名上次更新的时间。

created_at
string<date-time>
必填

域名的创建时间。

pod_id
string

Pod ID。

reason
string

Why the domain is not (yet) VERIFIED, when known. dns_records_missing / dns_records_invalid point at the DNS records. The ses_* values mean the records look right and sending-infrastructure validation has not converged: ses_dkim_pending / ses_mail_from_pending (still checking), ses_dkim_temporary_failure / ses_mail_from_temporary_failure (a transient error the infrastructure keeps retrying on its own — usually resolves without changes), ses_dkim_failed / ses_mail_from_failed (a terminal verdict; re-verify after fixing), ses_dkim_not_started / ses_mail_from_not_started (the attribute was never configured on the identity — re-verify to push it), and ses_not_verified_for_sending. Absent when VERIFIED.

inbound_enabled
boolean

Absent on domains created before this field existed; those receive email.

client_id
string

域的客户端 ID。