domains
POST /v1/domains/{domainId}/email-routing/enabled
Turn inbound email routing on for a domain.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението domains.dns.manage; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/enabled \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
This can destroy a customer's inbound mail. Enabling republishes the zone's apex MX and SPF, so any mail service the domain already uses stops receiving. The endpoint therefore refuses with 409 MAIL_WOULD_BE_REPLACED when the zone carries mail records that are not the provider's own, and the override is typed, not clicked: confirm_domain must be the domain's own name. A boolean would be settable by a client that never showed the customer anything. The judgement runs on a confirmed call as well as a refused one, so the override is audit-logged with the same evidence as the refusal — otherwise the one case that actually replaced live mail would be the one case with no record of what was there. A zone that cannot be read is a refusal, never a pass. Requires domains.dns.manage.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
domainId (path) | Uuid | Да | The domain's id. |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
confirm_domain | string | Не | The domain's own name, typed. Required only when impact.safe is false. A string rather than a boolean deliberately: a boolean would be settable by a client that never showed… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
domain_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
fqdn | string | Да | — |
supported | boolean | Да | — |
enabled | boolean | Да | — |
status | string | Да | The provider's own word for the zone's state. Displayed, never branched on. |
dns_ready | boolean | Да | Whether the provider reports the required DNS actually live. Distinct from enabled — a zone can be switched on with its MX not yet resolving. |
plan | DomainEmailRoutingDnsRecord[] | Да | — |
rules | DomainEmailRoutingRule[] | Да | — |
catch_all | DomainEmailRoutingRule | Да | — |
addresses | DomainEmailRoutingAddress[] | Да | — |
addresses_readable | boolean | Да | false when the credential could not list destination addresses — a scope a customer's own token may legitimately lack. Separate from an empty addresses list, because an empty… |
rules_readable | boolean | Да | false when the credential could not list the forwarding rules. Zone → Email Routing Rules is a separate Cloudflare permission from the one that reads the zone's routing… |
status_readable | boolean | Да | false when the credential could not read the zone's routing settings — the half that supplies enabled, status, dns_ready and plan. On Cloudflare this is a different… |
impact | DomainEmailRoutingImpact | Да | What turning routing on would replace, measured against the zone's live records. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 409 · 422 · 429 · 503