GET /v1/mail/routing/{fqdn}
How one domain's mail is routed.
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/routing/{fqdn} \
-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
Requires mail.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
fqdn (path) | string | Yes | The hostname whose mail routing is being read or changed. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
fqdn | string | Yes | The domain this routing is for. |
mechanism | string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none> | Yes | Which mechanism serves this domain's inbound mail. zinn_mailbox stores it; zinn_forward and cloudflare_routing pass it on and store nothing; external means the customer's… |
mechanism_label | string | Yes | Why this mechanism was chosen, in a sentence a person can act on. |
forwards | boolean | Yes | Whether mail is passed on rather than stored. |
stores | boolean | Yes | Whether this domain has real mailboxes on our relay. |
status | string<pending, converged, held, failed> | Yes | The last convergence pass's outcome. held is distinct from failed and means the zone could not be read, so nothing was changed — which is correct behaviour, not a fault. |
dns_authority | string<cloudflare, other, unknown> | Yes | Whose nameservers the zone was delegated to when last measured. unknown means the lookup did not answer — never that it is delegated elsewhere. |
catch_all | string | Yes | Where mail to any address on this domain is delivered. Empty when no forwarding alias exists — a domain with no deliverable destination gets no alias rather than one pointing… |
last_converged_at | string | No | When the world last agreed with the intended state. |
Errors this endpoint can return
401 · 403 · 404 · 429