GET /v1/mail/routing/{fqdn}
How one domain's mail is routed.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение mail.view; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/mail/routing/{fqdn} \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Requires mail.view.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
fqdn (path) | string | Да | The hostname whose mail routing is being read or changed. |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
fqdn | string | Да | The domain this routing is for. |
mechanism | string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none> | Да | Which mechanism serves this domain's inbound mail. zinn_mailbox stores it; zinn_forward and cloudflare_routing pass it on and store nothing; external means the customer's… |
mechanism_label | string | Да | Why this mechanism was chosen, in a sentence a person can act on. |
forwards | boolean | Да | Whether mail is passed on rather than stored. |
stores | boolean | Да | Whether this domain has real mailboxes on our relay. |
status | string<pending, converged, held, failed> | Да | The last convergence pass's outcome. held is distinct from failed and means the zone could not be read, so nothing was changed — which is correct behaviour, not a fault. |
dns_authority | string<cloudflare, other, unknown> | Да | Whose nameservers the zone was delegated to when last measured. unknown means the lookup did not answer — never that it is delegated elsewhere. |
catch_all | string | Да | Where mail to any address on this domain is delivered. Empty when no forwarding alias exists — a domain with no deliverable destination gets no alias rather than one pointing… |
last_converged_at | string | Нет | When the world last agreed with the intended state. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 429