hosting

POST /v1/sites/{siteId}/quota/resources/{resource}/downgrade

Reduce a site's allowance — refused while the site is over the target.

Wszystkie punkty końcowe hosting

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).
resource (path)string<disk, inodes, bandwidth, database>TakWhich 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…

Treść żądania

NazwaTypWymaganeCo to jest
targetnumberTakThe 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.

Odpowiedź

NazwaTypWymaganeCo to jest
resourcestring<disk, inodes, bandwidth, database>Tak
unitSiteQuotaUnitTakThe 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…
stepintegerTakOne purchasable step, in unit. A customer buys N of these, never an arbitrary size.
basenumberTakThe 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…
grantednumberTakExtra from grants live right now — staff gestures and purchased upgrades, added together.
totalnumberTakThe effective ceiling — base + granted. null when base is null.
usednumberTakMeasured usage. null means unknown — the box was unreachable, or nothing has sampled it yet — and never 0. A client must render those differently.
percentintegerTakUsage as a whole percentage of total, or null when either is unknown.
measured_atstringTakWhen 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_atstringTakWhen 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_percentinteger[]TakThe thresholds at which the platform notifies the customer, ascending.
price_minorintegerTakCost 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_currencystringTak
price_intervalstring<monthly, yearly>Tak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422 · 429