hosting
PUT /v1/sites/{siteId}/cache
Set a site's server-side cache times.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/cache \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "css_seconds": <integer>, "image_seconds": <integer>, "javascript_seconds": <integer> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Writes the three cache times a package lets a customer change, and returns the whole cache state so the card re-renders from the server's answer rather than from what it asked for. PUT because the body states the desired end state. ⛔⛔ All three classes are required, every time, and that is the contract rather than an oversight. The vendor replaces the stored policy with exactly the body it is given, so a request naming two classes deletes the third — silently, with a cheerful acknowledgement. Making the fields optional would put that footgun on the wire where every future client would find it. A value outside 0…31536000 seconds is refused 422 before the vendor is called, as is a package type whose cache settings it does not permit. 404 for a site with no vendor hosting package, or one that is not the caller's. Requires sites.view and sites.panel_access.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
siteId (path) | Uuid | כן | Site ID (UUIDv7). |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
css_seconds | integer | כן | How long stylesheets should be cached, in seconds. Zero is "do not cache". |
image_seconds | integer | כן | How long images should be cached, in seconds. |
javascript_seconds | integer | כן | How long scripts should be cached, in seconds. |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
permitted | boolean | כן | Whether the package type exposes cache settings and the report at all. |
purge_permitted | boolean | כן | Whether a purge is permitted. Separate from permitted on purpose: the purge was measured working on a package whose cache settings and report the vendor refuses. |
css_seconds | integer | כן | How long stylesheets are cached. |
image_seconds | integer | כן | How long images are cached. |
javascript_seconds | integer | כן | How long scripts are cached. |
reported | object | כן | Every asset class the vendor reported, keyed by its own name, including the classes that cannot be written. ⛔ Read-only on a client: writing them deletes them, because the vendor… |
report_available | boolean | כן | Whether the cacheability report could be read. False renders an explanation rather than an empty table, so "nothing has been seen yet" and "not part of this plan" never look… |
report | SiteCacheReportRow[] | כן | What the platform did with the URLs it has seen. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429 · 503