hosting

PATCH /v1/sites/{siteId}/cdn/budget

Set this site's metered CDN spend ceiling.

Všechny koncové body hosting

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění hosting.cdn.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X PATCH https://api.zinndigital.com/v1/sites/{siteId}/cdn/budget \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "cap_minor": <integer> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

cap_minor: 0 means no per-site ceiling — the account cap alone applies — and is the default. Any other value must be at least the platform minimum; a cap of a few cents is a site that pauses on its first visitor and reads as broken hosting rather than as a budget working. Raising the cap above what the site has already spent resumes it. Leaving it paused would require a second, undiscoverable action and would read as the setting not working. A site paused by staff is not resumed by this — that pause is not the customer's to lift. Requires hosting.cdn.manage.

Parametry

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).

Tělo požadavku

NázevTypPožadovánoCo to je
cap_minorintegerAno0 for no per-site ceiling, otherwise at least the platform minimum.

Odpověď

NázevTypPožadovánoCo to je
cap_minorintegerAnoThis site's ceiling in integer minor units. 0 means no per-site ceiling — the account cap alone applies.
spent_period_minorintegerAno
statestring<active, paused_cap, paused_standing, paused_admin>AnoFour states rather than a boolean, because the remedy differs: the customer's own cap is self-service, a standing lapse needs a payment, and a staff pause needs staff.
paused_reasonstringNe
meteredbooleanAnoWhether this site is on the tier that pays per gigabyte.
servingbooleanNeWhether the metered CDN is serving right now. Reads both this site's state and its account's, because either can pause it. ⛔ Absent entirely when metered is false,…
currencystringNeISO code denominating cap_minor and spent_period_minor (§2.8). ⛔ Absent when the org has not opened metered credit, because minor units without an exponent are unreadable: a…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429