mail

PATCH /v1/mail/routing/{fqdn}

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

Барлық mail соңғы нүктелері

Барлық әзірлеуші құжаттамасы

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте 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 консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған 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.

Параметрлер

АтыTүріМіндеттіМазмұны
fqdn (path)stringИәThe hostname whose mail routing is being read or changed.

Сұрау денесі

АтыTүріМіндеттіМазмұны
destinationstringИәWhere mail to any address on this domain is delivered.

Жауап

АтыTүріМіндеттіМазмұны
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