domains
POST /v1/domains/{domainId}/email-routing/enabled
Turn inbound email routing on for a domain.
認証
ベアラー トークンとして API キーを送信します。キーには domains.dns.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 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. |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503