mail

GET /v1/mail/free-tier

What a free mailbox is, and what it costs to provide.

Tous les points de terminaison mail

Toute la documentation pour développeurs

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation mail.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X GET https://api.zinndigital.com/v1/mail/free-tier \
  -H "Authorization: Bearer zdk_live_…"

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

The free mailbox tier's quota, per-organization ceiling and derived capacity. Requires mail.view. ⭐ Published rather than written down. Every figure is computed from the measured relay capacity and the configured quota, so raising the quota lowers the mailbox count and raises the stated per-mailbox cost with no second edit. A screen or a pricing page that restated these numbers would be a second expression of the same arithmetic, and would go stale the first time the quota moved.

Réponse

NomTypeObligatoireQu'est-ce que c'est
availablebooleanOuiWhether free mailboxes are actually on offer. Two measured legs, not a switch. The first is "does mail land on our own relay" — true exactly when every mail hostname we…
unavailable_causestring<relay, headroom, >OuiWhich leg refused, so that two situations sharing one symptom stay distinguishable. relay means the mail hostnames are not ours — a routing decision. headroom means the relay…
reserve_percentintegerOuiHow much of the relay is held back from the free tier for the mail somebody is paying for. Free and paid mailboxes share one disk, and the failure this prevents is a paying…
offerable_bytesintegerOuiUsable storage less the reserve — what the free tier may draw on.
committed_bytesintegerOuiStorage already promised to mailboxes on the relay — every mailbox, not only free ones, because a paid mailbox occupies the same disk.
headroom_bytesintegerOuiOfferable storage still unpromised. Negative when the relay is oversubscribed.
unavailable_reasonstringOuiWhy free mailboxes are not on offer, in a sentence an operator can act on. Empty when available is true. Names our own configuration rather than any supplier.
relay_zonestringOuiThe apex of our own mail relay — the name available compares against.
quota_mbintegerOuiPer-mailbox size of a free mailbox, in MB.
per_org_ceilingintegerOuiHow many free mailboxes one organization may hold. A ceiling rather than a target, and the only term a customer can move — which is what stops the offer running away.
usable_bytesintegerOuiMail-available storage on one relay node, measured rather than assumed.
node_monthly_eurintegerOuiWhat one relay node costs per month.
mailboxes_per_nodeintegerOuiHow many fully-used free mailboxes one node holds.
orgs_per_nodeintegerOuiHow many organizations one node holds if every one fills its ceiling.
worst_case_cost_per_mailbox_eurnumberOuiWhat a free mailbox costs per month, fully used. Worst case deliberately: a figure computed from average fill is a claim about customer behaviour dressed as a cost, and it is…

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 429