GET /v1/mail/preflight
What setting email up on a domain would do to its DNS.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda mail.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí
Oju-iwọle yii nlo org_id gẹgẹbi ayẹwo ibeere. Fi silẹ ni ita yoo si bo igi iyalo rẹ lapapọ; ranṣẹ si lati dín ibeere naa kù si ajọ kan.
Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.
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/mail/preflight?fqdn=<fqdn> \
-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ẹ̀
Read-only. Answers before the customer commits whether this domain can take our mail records, and exactly what publishing them would remove (#662). Setting mail up rewrites the domain's apex MX. If the domain already receives email somewhere else, that stops inbound mail reaching the mailboxes it is addressed to — an outage the customer usually learns about from the people who could not reach them. Without this endpoint the only way to discover the refusal was to create a service and watch it fail asynchronously, which is a refusal arriving after the decision. safe: false means POST /v1/mail/services will refuse unless it is called with the override flag. foreign_mx and would_delete are listed verbatim, not counted, because a customer must be able to see what they are about to destroy before confirming it. zone_unreadable: true is never safe: there is no DNS resolver in the platform, so "we could not read the zone" is the normal answer for a domain whose DNS is hosted elsewhere, and treating that as safe would disable the guard exactly where it matters most. ⚠️ A safe answer is not a promise — the zone can change between this call and the apply, so provisioning repeats the check inside its workflow. Requires mail.view.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
fqdn (query) | string | Bẹẹni | The domain to check. |
provider (query) | MailProvider | Bẹẹkọ | Which provider's records to test against; defaults to our own mail. The answer differs per provider, because each preset publishes a different record set. |
mx_hosts (query) | string | Bẹẹkọ | custom only: the MX targets the reseller has typed so far, comma-separated. The preflight compares the zone with the records the preset would publish, and for a provider we… |
org_id (query) | Uuid | Bẹẹkọ | The organization to act in; defaults to the caller's own when unambiguous. |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
domain | string | Bẹẹni | The domain that was checked, normalised. |
safe | boolean | Bẹẹni | Whether an apply would proceed without the override flag. false means POST /v1/mail/services returns 409 unless the customer confirms. |
existing_apex_mx | string[] | Bẹẹni | Every apex MX currently published, in the order DNS returned them. |
foreign_mx | string[] | Bẹẹni | The apex MX targets that are not ours to replace — the reason for a refusal, and the list the customer must see before confirming an override. |
foreign_spf_includes | string[] | Bẹẹni | include: mechanisms in the current SPF that the new record would drop. |
would_delete | string[] | Bẹẹni | Records the apply would remove or replace, as "NAME TYPE VALUE". |
zone_unreadable | boolean | Bẹẹni | The zone could not be read at all — never safe. Distinct from "read it, found nothing", because the two need different copy: one is "we cannot see your DNS", the other is "your… |
reason | string | Bẹẹni | Customer-grade English describing what was found. Empty when safe. |
warnings | string[] | Bẹẹni | Non-blocking observations about the zone. |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 422 · 429 · 503