hosting

PUT `/v1/sites/{siteId}/cache`

Set a site's server-side cache times.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (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

التفاصيل

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 vendo…
`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 ide…
`report`	`SiteCacheReportRow[]`	نعم	What the platform did with the URLs it has seen.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/sites/{siteId}/cache