Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
css_seconds | integer | Yes | How long stylesheets should be cached, in seconds. Zero is "do not cache". |
image_seconds | integer | Yes | How long images should be cached, in seconds. |
javascript_seconds | integer | Yes | How long scripts should be cached, in seconds. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
permitted | boolean | Yes | Whether the package type exposes cache settings and the report at all. |
purge_permitted | boolean | Yes | 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 | Yes | How long stylesheets are cached. |
image_seconds | integer | Yes | How long images are cached. |
javascript_seconds | integer | Yes | How long scripts are cached. |
reported | object | Yes | 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 | Yes | 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[] | Yes | What the platform did with the URLs it has seen. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503