hosting
POST /v1/sites/{siteId}/quota/resources/{resource}/downgrade
Reduce a site's allowance — refused while the site is over the target.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/quota/resources/{resource}/downgrade \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "target": <number> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Owner ruling: downgrades are allowed only when the site is not over the limit. The check is made against a live reading of the box, not a stored sample: a downgrade is an irreversible narrowing the customer meets at their next write, so an hour-old figure could license one that is already breached. ⛔ An unreadable usage is a refusal, not a pass. If the box cannot be measured the request answers 422; "we could not tell, so we allowed it" is how a customer ends up above a ceiling they did not choose. The 422 body names the real numbers — "This site is using 1.90 GB of disk, which is more than the 1.00 GB you asked for" — because a customer told only "you cannot reduce this" files a ticket, and one told the figures deletes something. Purchased grants for the resource are revoked so the ceiling is the number asked for; staff gestures are deliberately left alone. Requires sites.view and hosting.quota.manage.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
siteId (path) | Uuid | כן | Site ID (UUIDv7). |
resource (path) | string<disk, inodes, bandwidth, database> | כן | Which metered per-site resource. Every SELLABLE resource is addressable: disk and inodes are written to the box where the driver can hold them, while bandwidth (since the… |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
target | number | כן | The new ceiling, in the resource's sold unit. Refused with 422 when the site is currently using more than this, or when its usage cannot be read. |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
resource | string<disk, inodes, bandwidth, database> | כן | — |
unit | SiteQuotaUnit | כן | The unit a quota's figures are expressed in, as a code the client localises — never a word to render raw. GB for disk and bandwidth, files for inodes, MB for the… |
step | integer | כן | One purchasable step, in unit. A customer buys N of these, never an arbitrary size. |
base | number | כן | The site's own allowance, copied from the product line's admin-set default when the site was provisioned. null means this site has no limit row yet — it has not been through… |
granted | number | כן | Extra from grants live right now — staff gestures and purchased upgrades, added together. |
total | number | כן | The effective ceiling — base + granted. null when base is null. |
used | number | כן | Measured usage. null means unknown — the box was unreachable, or nothing has sampled it yet — and never 0. A client must render those differently. |
percent | integer | כן | Usage as a whole percentage of total, or null when either is unknown. |
measured_at | string | כן | When the box was last asked. Render the age. A bar drawn from a two-day-old reading looks identical to one drawn a minute ago, and the customer cannot tell. |
reverts_at | string | כן | When the ceiling next drops, because a temporary grant expires. null when no live grant has an expiry. A customer whose limit is about to fall needs to know before it does. |
warn_at_percent | integer[] | כן | The thresholds at which the platform notifies the customer, ascending. |
price_minor | integer | כן | Cost of ONE step, in integer minor units of price_currency, NET of tax. null means no price is published in the caller's currency — the client must then show no upgrade… |
price_currency | string | כן | — |
price_interval | string<monthly, yearly> | כן | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429