hosting
GET /v1/sites/{siteId}/cache-health
Get a site's latest Zinn® Cache Pro cache-health report.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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 GET https://api.zinndigital.com/v1/sites/{siteId}/cache-health \
-H "Authorization: Bearer zdk_live_…"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
The newest hourly report Zinn® Cache Pro sent about the site's object cache — hit ratio, Redis memory, evicted keys, whether it is connected — and the problems the engine found in it, which are exactly the problems the customer is e-mailed about (edge-triggered, one message when a problem appears and one when it clears). RLS-scoped to a site the caller can view (sites.view); an out-of-scope or unknown id is a 404. Until the site has reported, reported is false.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
reported | boolean | Yes | — |
received_at | string | No | — |
plugin_version | string | No | — |
licensed | boolean | No | — |
connected | boolean | No | — |
fallback | boolean | No | — |
last_error | string | No | — |
hit_ratio_1h | number | No | — |
hit_ratio_24h | number | No | — |
requests_1h | integer | No | — |
avg_ms | number | No | — |
server_hit_ratio | number | No | — |
used_memory | integer | No | — |
maxmemory | integer | No | — |
evicted_keys | integer | No | — |
uncached_by | SiteCacheHealthComponentRow[] | No | — |
slow_queries_by | SiteCacheHealthComponentRow[] | No | — |
problems | SiteCacheHealthProblem[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404