mail

PATCH /v1/mail/routing/{fqdn}

Re-point a forwarding domain's catch-all.

ټول mail پای ټکي

ټول د پراختیا کونکي اسناد

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د mail.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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.

د غوښتنې بدن

نومډولاړیندا څه شی دی
destinationstringهوWhere mail to any address on this domain is delivered.

ځواب

نومډولاړیندا څه شی دی
fqdnstringهوThe domain this routing is for.
mechanismstring<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_labelstringهوWhy this mechanism was chosen, in a sentence a person can act on.
forwardsbooleanهوWhether mail is passed on rather than stored.
storesbooleanهوWhether this domain has real mailboxes on our relay.
statusstring<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_authoritystring<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_allstringهو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_atstringنهWhen the world last agreed with the intended state.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 422 · 429