mail

GET `/v1/mail/preflight`

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`fqdn (query)`	`string`	Ano	The domain to check.
`provider (query)`	`MailProvider`	Ne	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`	Ne	`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`	Ne	The organization to act in; defaults to the caller's own when unambiguous.

Odpověď

Název	Typ	Požadováno	Co to je
`domain`	`string`	Ano	The domain that was checked, normalised.
`safe`	`boolean`	Ano	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[]`	Ano	Every apex `MX` currently published, in the order DNS returned them.
`foreign_mx`	`string[]`	Ano	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[]`	Ano	`include:` mechanisms in the current SPF that the new record would drop.
`would_delete`	`string[]`	Ano	Records the apply would remove or replace, as `"NAME TYPE VALUE"`.
`zone_unreadable`	`boolean`	Ano	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`	Ano	Customer-grade English describing what was found. Empty when safe.
`warnings`	`string[]`	Ano	Non-blocking observations about the zone.

Chyby, které může tento koncový bod vrátit

401 · 403 · 422 · 429 · 503