domains

POST /v1/domains/{domainId}/email-routing/enabled

Turn inbound email routing on for a domain.

Όλα τα τελικά σημεία domains

Όλα τα έγγραφα προγραμματιστών

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα domains.dns.manage· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.

Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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, ώστε να μπορείτε να δείτε την πραγματική απόκριση. Ανοίξτε αυτό το τελικό σημείο στην κονσόλα 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.

Παράμετροι

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
domainId (path)UuidΝαιThe domain's id.

Σώμα αίτησης

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
confirm_domainstringΌχι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…

Απάντηση

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
domain_idUuidΝαιUUIDv7 identifier — sortable by creation time (docs/02 §8).
fqdnstringΝαι
supportedbooleanΝαι
enabledbooleanΝαι
statusstringΝαιThe provider's own word for the zone's state. Displayed, never branched on.
dns_readybooleanΝαιWhether the provider reports the required DNS actually live. Distinct from enabled — a zone can be switched on with its MX not yet resolving.
planDomainEmailRoutingDnsRecord[]Ναι
rulesDomainEmailRoutingRule[]Ναι
catch_allDomainEmailRoutingRuleΝαι
addressesDomainEmailRoutingAddress[]Ναι
addresses_readablebooleanΝαι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_readablebooleanΝαι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_readablebooleanΝαι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…
impactDomainEmailRoutingImpactΝαιWhat turning routing on would replace, measured against the zone's live records.

Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο

401 · 403 · 404 · 409 · 422 · 429 · 503