mail

GET `/v1/mail/preflight`

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar mail.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`fqdn (query)`	`string`	Evet	The domain to check.
`provider (query)`	`MailProvider`	Hayır	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`	Hayır	`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`	Hayır	The organization to act in; defaults to the caller's own when unambiguous.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`domain`	`string`	Evet	The domain that was checked, normalised.
`safe`	`boolean`	Evet	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[]`	Evet	Every apex `MX` currently published, in the order DNS returned them.
`foreign_mx`	`string[]`	Evet	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[]`	Evet	`include:` mechanisms in the current SPF that the new record would drop.
`would_delete`	`string[]`	Evet	Records the apply would remove or replace, as `"NAME TYPE VALUE"`.
`zone_unreadable`	`boolean`	Evet	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`	Evet	Customer-grade English describing what was found. Empty when safe.
`warnings`	`string[]`	Evet	Non-blocking observations about the zone.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 422 · 429 · 503