PATCH /v1/mail/routing/{fqdn}
Re-point a forwarding domain's catch-all.
認証
ベアラー トークンとして API キーを送信します。キーには mail.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PATCH https://api.zinndigital.com/v1/mail/routing/{fqdn} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "destination": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Sets where everything addressed to this domain is delivered. Requires mail.manage. ⛔ Taking ownership is part of the write. The alias stops being system-managed, so the convergence sweep will never reassert our computed destination over the customer's choice — silently, which is the only way that failure would ever be noticed. ⛔ Refused with 422 on a domain that stores its mail in mailboxes, rather than accepted and ignored: a forwarding address on a mailbox domain is a control that appears to work while mail keeps arriving in the mailbox.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
fqdn (path) | string | はい | The hostname whose mail routing is being read or changed. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
destination | string | はい | Where mail to any address on this domain is delivered. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 422 · 429