Skip to main content

DnsRecord

typestringrequired

DNS record type.

Possible values: [TXT, MX]

hoststringrequired

Full hostname to set this record on.

Example: send._domainkey.notifications.example.com
valuestringrequired

Expected DNS record value.

Example: v=DKIM1; k=rsa; p=MIIBIj...
statusstringrequired

Verification status of this record.

Possible values: [unverified, verifying, active, failed]

priorityinteger

MX record priority. Only present for MX records.

Example: 10
purposestringrequired

Whether this record is for sending (SPF, DKIM, DMARC) or receiving (MX).

Possible values: [sending, receiving]

kindstring

Semantic kind of the record (so clients can label rows without parsing values).

Possible values: [spf, dkim, dmarc, mx_inbound]

last_verification_errorstring

Human-readable explanation of the most recent verification failure. Empty when verified.

requiredbooleanrequired

Whether this record must be verified for the domain to become active.

DnsRecord
{
"type": "TXT",
"host": "send._domainkey.notifications.example.com",
"value": "v=DKIM1; k=rsa; p=MIIBIj...",
"status": "unverified",
"priority": 10,
"purpose": "sending",
"kind": "spf",
"last_verification_error": "string",
"required": true
}