hosting

GET /v1/sites/{siteId}/cache-health

Get a site's latest Zinn® Cache Pro cache-health report.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The endpoint checks sites.view; 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 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

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
reportedbooleanYes—
received_atstringNo—
plugin_versionstringNo—
licensedbooleanNo—
connectedbooleanNo—
fallbackbooleanNo—
last_errorstringNo—
hit_ratio_1hnumberNo—
hit_ratio_24hnumberNo—
requests_1hintegerNo—
avg_msnumberNo—
server_hit_rationumberNo—
used_memoryintegerNo—
maxmemoryintegerNo—
evicted_keysintegerNo—
uncached_bySiteCacheHealthComponentRow[]No—
slow_queries_bySiteCacheHealthComponentRow[]No—
problemsSiteCacheHealthProblem[]Yes—

Errors this endpoint can return

401 · 403 · 404