mail

GET /v1/mail/routing/{fqdn}

How one domain's mail is routed.

Wszystkie punkty końcowe mail

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

Requires mail.view.

Parametry

NazwaTypWymaganeCo to jest
fqdn (path)stringTakThe hostname whose mail routing is being read or changed.

Odpowiedź

NazwaTypWymaganeCo to jest
fqdnstringTakThe domain this routing is for.
mechanismstring<zinn_mailbox, zinn_forward, cloudflare_routing, external, none>TakWhich 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_labelstringTakWhy this mechanism was chosen, in a sentence a person can act on.
forwardsbooleanTakWhether mail is passed on rather than stored.
storesbooleanTakWhether this domain has real mailboxes on our relay.
statusstring<pending, converged, held, failed>TakThe 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>TakWhose nameservers the zone was delegated to when last measured. unknown means the lookup did not answer — never that it is delegated elsewhere.
catch_allstringTakWhere 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_atstringNieWhen the world last agreed with the intended state.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429