mail

GET /v1/mail/routing/{fqdn}

How one domain's mail is routed.

Všechny koncové body mail

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Requires mail.view.

Parametry

NázevTypPožadovánoCo to je
fqdn (path)stringAnoThe hostname whose mail routing is being read or changed.

Odpověď

NázevTypPožadovánoCo to je
fqdnstringAnoThe domain this routing is for.
mechanismstring<zinn_mailbox, zinn_forward, cloudflare_routing, external, none>AnoWhich 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_labelstringAnoWhy this mechanism was chosen, in a sentence a person can act on.
forwardsbooleanAnoWhether mail is passed on rather than stored.
storesbooleanAnoWhether this domain has real mailboxes on our relay.
statusstring<pending, converged, held, failed>AnoThe 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_authoritystring<cloudflare, other, unknown>AnoWhose nameservers the zone was delegated to when last measured. unknown means the lookup did not answer — never that it is delegated elsewhere.
catch_allstringAnoWhere 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_atstringNeWhen the world last agreed with the intended state.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429