mail

GET /v1/mail/services/{mailServiceId}/dns-records

Every DNS record this domain needs for email, each checked live.

All mail endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the mail.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/dns-records \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The exact records (type, host, value, priority) the domain needs for its email provider - MX, SPF, DKIM, DMARC and the mail-app discovery records - from the same preset the provisioning publishes, so what is shown is what would be written. Each record carries a live status asked of the domain's OWN nameservers: ok, missing, different (with what was found instead) or unknown when the nameservers could not be asked (never shown as ok or missing). dns_hosted says whether we publish them (ours) or the customer adds them at their DNS provider (external). The support AI reads the same list. 422 for our own mail under a white label, as the connection settings are. Requires mail.view.

Parameters

NameTypeRequiredWhat it is
mailServiceId (path)UuidYesEmail service ID (UUIDv7).

Response

NameTypeRequiredWhat it is
domainstringYes—
providerstringYes—
dns_hostedstring<ours, external, unknown>Yesours: we publish the records. external: add them at your DNS provider.
nameserversstring[]Yes—
recordsMailDnsRecordCheck[]Yes—
all_okbooleanYesTrue when every record is live; null when any could not be checked.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503