mail

GET `/v1/mail/preflight`

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

모든 mail 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 mail.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

조직 ID가 들어가는 위치

이 엔드포인트는 org_id을(를) 쿼리 매개변수로 사용합니다. 생략하면 테넌트 하위 트리 전체가 호출 대상이 되며, 값을 전달하면 특정 조직으로 호출 범위를 좁힐 수 있습니다.

조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

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

매개변수

이름	유형	필수	설명
`fqdn (query)`	`string`	예	The domain to check.
`provider (query)`	`MailProvider`	아니요	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`	아니요	`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`	아니요	The organization to act in; defaults to the caller's own when unambiguous.

응답

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

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 422 · 429 · 503