domains

GET /v1/domains/{domainId}/email-routing

Read a domain's inbound email routing, and what enabling it would cost.

Gbogbo àwọn domains endpoints

Gbogbo àwọn ìwé àṣẹ olùgbékalẹ̀ àgbékalẹ̀

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda sites.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

curl -X GET https://api.zinndigital.com/v1/domains/{domainId}/email-routing \
  -H "Authorization: Bearer zdk_live_…"

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

Cloudflare Email Routing on the customer's own account: whether it is on, the forwarding rules, the catch-all, the verified destination addresses, and the DNS the provider would publish to make it work. Scoped to the domain rather than a site, because routing is a zone-level feature — one switch and one rule set per zone however many sites hang off it. impact is the important field. Email Routing's DNS plan is apex-only: turning it on republishes the apex MX set and an apex SPF TXT, so a domain whose mail is at Google Workspace or Microsoft 365 would lose it. impact compares the provider's own published plan against the zone's live records on every read, so what the customer is warned about and what the enable endpoint refuses are the same value and cannot drift. impact.zone_unreadable is reported separately from impact.safe because "we could not read your DNS" and "your domain already receives mail elsewhere" are both unsafe and need completely different copy. addresses_readable is likewise separate from an empty addresses list: a credential may legitimately lack the account-level scope, and "we could not look" must not render as "there are none". rules_readable is the same distinction for the forwarding rules, which sit behind a different Cloudflare permission again — so a partially-scoped token returns a usable status, plan and impact with the rule list honestly marked unreadable, rather than failing the whole read. Requires sites.view. ⛔ A credential that lacks a required scope answers 422, never 503: a permission gap is the one failure a retry can never clear, and telling a customer to "try again shortly" sends them round a loop with no exit (D16780).

Àwọn ìpìlẹ̀

OrúkọIruTí a nílòKini o jẹ
domainId (path)UuidBẹẹniThe domain's id.

Idahun

OrúkọIruTí a nílòKini o jẹ
domain_idUuidBẹẹniUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringBẹẹni
supportedbooleanBẹẹni
enabledbooleanBẹẹni
statusstringBẹẹniThe provider's own word for the zone's state. Displayed, never branched on.
dns_readybooleanBẹẹniWhether the provider reports the required DNS actually live. Distinct from enabled — a zone can be switched on with its MX not yet resolving.
planDomainEmailRoutingDnsRecord[]Bẹẹni
rulesDomainEmailRoutingRule[]Bẹẹni
catch_allDomainEmailRoutingRuleBẹẹni
addressesDomainEmailRoutingAddress[]Bẹẹni
addresses_readablebooleanBẹẹnifalse when the credential could not list destination addresses — a scope a customer's own token may legitimately lack. Separate from an empty addresses list, because an empty…
rules_readablebooleanBẹẹnifalse when the credential could not list the forwarding rules. Zone → Email Routing Rules is a separate Cloudflare permission from the one that reads the zone's routing…
status_readablebooleanBẹẹnifalse when the credential could not read the zone's routing settings — the half that supplies enabled, status, dns_ready and plan. On Cloudflare this is a different…
impactDomainEmailRoutingImpactBẹẹniWhat turning routing on would replace, measured against the zone's live records.

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 422 · 429 · 503