GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте mail.view рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
Whether this domain's mail is set up to be delivered - the question a customer asks when their messages land in spam. ⛔ A different question from /preflight, which asks what setting mail up here would destroy; both read the same underlying report so a preview and the fix cannot disagree. fixable is false when the apex MX belongs to somebody else or the zone cannot be read, because a one-click apply would then either destroy working mail or write blind. Requires mail.view.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
mailServiceId (path) | Uuid | Иә | Email service ID (UUIDv7). |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
domain | string | Иә | — |
healthy | boolean | Иә | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Иә | — |
dkim_ok | boolean | Иә | — |
dmarc_ok | boolean | Иә | — |
fixable | boolean | Иә | Whether a one-click apply is offered. False over a foreign apex MX or an unreadable zone - the panel shows the reason instead of a button. |
needs_confirmation | boolean | Иә | True when applying would replace published records, so confirm is required. |
existing_apex_mx | string[] | Иә | — |
foreign_mx | string[] | Иә | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Иә | — |
would_delete | string[] | Иә | Records an apply would remove or replace, as NAME TYPE VALUE. Listed verbatim rather than counted: a customer must not be able to destroy mail records without seeing which ones… |
zone_unreadable | boolean | Иә | — |
reason | string | Иә | Customer-grade English. Never a driver message. |
warnings | string[] | Иә | — |
live_mx | string[] | Иә | The domain's MX hosts as PUBLIC DNS answers them right now (W43-09) - not our record of the zone. Empty when the domain publishes no MX, or when it could not be read (see… |
mx_readable | boolean | Иә | False when the public MX lookup failed. A failed lookup is never read as "action needed". |
mx_ok | boolean | Иә | Every live MX host is one this preset publishes, and there is at least one. |
action_needed | boolean | Иә | The customer's OWN DNS must change: we cannot publish to this zone and its live MX does not point where this preset sends mail. The panel then lists required_records with copy… |
required_records | object[] | Иә | The exact records to publish, as our preset would write them into a zone we host. |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 404 · 429