mail

GET `/v1/mail/preflight`

What setting email up on a domain would do to its DNS.

Xaqiijinta aqoonsiga

U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda mail.view; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.

Meesha aqoonsiga ururkaagu galayo

Endpoint-kani wuxතික org_id oo ah cabbir su'aal ah. Ka tag oo wicitaanku wuxuu daboolayaa dhammaan geedkaaga kiraynta; soo dir si aad wicitaanka ugu koobto hal urur.

Aqoonsiga ururkaagu wuxuu ku yaallaa shaashada furayaasha API ee dashboard-kaaga, oo ku xiga furaha laftiisa. Waa isku aqoonsi wicitaan kasta oo aad sameyso.

Isku day

Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.

curl -X GET https://api.zinndigital.com/v1/mail/preflight?fqdn=<fqdn> \
  -H "Authorization: Bearer zdk_live_…"

Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API

Details

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`.

Cabiraha

Magaca	Nooc	Loo baahan yahay	Maxay tahay
`fqdn (query)`	`string`	Haa	The domain to check.
`provider (query)`	`MailProvider`	Maya	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`	Maya	`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 w…
`org_id (query)`	`Uuid`	Maya	The organization to act in; defaults to the caller's own when unambiguous.

Jawaab

Magaca	Nooc	Loo baahan yahay	Maxay tahay
`domain`	`string`	Haa	The domain that was checked, normalised.
`safe`	`boolean`	Haa	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[]`	Haa	Every apex `MX` currently published, in the order DNS returned them.
`foreign_mx`	`string[]`	Haa	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[]`	Haa	`include:` mechanisms in the current SPF that the new record would drop.
`would_delete`	`string[]`	Haa	Records the apply would remove or replace, as `"NAME TYPE VALUE"`.
`zone_unreadable`	`boolean`	Haa	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 "you…
`reason`	`string`	Haa	Customer-grade English describing what was found. Empty when safe.
`warnings`	`string[]`	Haa	Non-blocking observations about the zone.

Cilladaha ay bartaani soo celin karto

401 · 403 · 422 · 429 · 503