mail

GET `/v1/mail/preflight`

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

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea mail.view; o cheie care nu o are va fi respinsă cu 403, nu 404.

Unde merge ID-ul organizației tale

Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.

ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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

Parametri

Nume	Tip	Obligatoriu	Ce este
`fqdn (query)`	`string`	Da	The domain to check.
`provider (query)`	`MailProvider`	Nu	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`	Nu	`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`	Nu	The organization to act in; defaults to the caller's own when unambiguous.

Răspuns

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

Erori pe care le poate returna acest punct final

401 · 403 · 422 · 429 · 503