hosting

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

This site's slice of the account's metered CDN spend.

כל נקודות הקצה מסוג hosting

כל תיעוד המפתחים

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/cdn/budget \
  -H "Authorization: Bearer zdk_live_…"

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

A per-site ceiling, which exists so that one site cannot take the rest of an account down with it. With only an account-level cap, a single crawled domain spends the whole balance and every other site in the account stops serving — a denial of service on a customer's entire estate, triggered by a stranger with a scraper. serving is the honest answer to "is the CDN working right now?" and reads both this site's state and its account's, because either can pause it. Requires sites.view.

פרמטרים

שםסוגנדרשמה זה
siteId (path)UuidכןSite ID (UUIDv7).

תשובה

שםסוגנדרשמה זה
cap_minorintegerכןThis site's ceiling in integer minor units. 0 means no per-site ceiling — the account cap alone applies.
spent_period_minorintegerכן
statestring<active, paused_cap, paused_standing, paused_admin>כןFour 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_reasonstringלא
meteredbooleanכןWhether this site is on the tier that pays per gigabyte.
servingbooleanלאWhether 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,…
currencystringלאISO 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…

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 429