Get a site's Varnish statistics
Answers the cache's figures over the last hour, day or week, in equal steps: hits, misses, requests, the hit ratio, cached pages and memory, with the totals and the recent purges. available is false, with a reason, until the site has been sampled.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Query parameters
How far back.
1h24h7dReturns
200 The statistics. buckets is shortened here.
Fields of the 200 answer
The length of one step.
One entry a step. A figure is null where there was no sample.
Fields of each item
Format: date-time.
Cached pages.
True where the counters started again, for example after a version change.
The site's hostnames.
Fields
Format: date-time.
1h24h7dWhy there are no figures, such as sampler_pending before the first sample.
The latest purges, newest first.
Fields of each item
Format: date-time.
The person who asked, by name. Null for a purge nobody asked for, or when the account no longer exists.
At least 1.
What the trigger refers to, when it names something. For a deployment, its id.
Who or what asked: a person, a deployment, or the platform by itself (automatic).
persondeploymentautomaticWhat set off a purge nobody asked for, such as deployment, go_live or enable. Null for a person's.
Where a person asked. Null for a purge nobody asked for.
panelapimcpnullFormat: date-time.
True when the latest sample is old.
The same figures over the whole range. A figure is null while there are no samples for it; missing names those.
Fields
How many times the counters started again in the range.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
409 | varnish_not_offered | Varnish is available for Magento 2 sites only. Nothing to change here. |
409 | varnish_off | Varnish is off on the environment. Switch it on first. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/sites/1042/varnish/stats",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"available": true,
"bucket_seconds": 3600,
"buckets": [
{
"at": "2026-11-06T08:00:00Z",
"backend_errors": 0,
"backend_fetches": 840,
"bytes_free": 402653184,
"bytes_used": 268435456,
"evictions": 0,
"hit_ratio": 0.9,
"hits": 5400,
"misses": 600,
"objects": 4200,
"passes": 240,
"requests": 6240,
"requests_per_s": 1.73,
"reset": false,
"samples": 12,
"storage_bytes": 671088640,
"transient_bytes": 1048576
}
],
"from": "2026-11-05T09:00:00Z",
"hosts": [
"harbourandfinch.example.com",
"www.harbourandfinch.example.com"
],
"purges_this_hour": {
"available_at": null,
"limit": 10,
"used": 1
},
"range": "24h",
"reason": null,
"recent_purges": [
{
"at": "2026-11-06T09:16:40Z",
"by": {
"name": "Eleanor Finch"
},
"confirmed": true,
"hosts": [],
"id": 905,
"item_count": 2,
"items": [
"cat_p_1180",
"cat_c_27"
],
"mode": "tags",
"reference": null,
"source": "person",
"status": "succeeded",
"trigger": null,
"via": "api"
},
{
"at": "2026-11-06T08:41:07Z",
"by": null,
"confirmed": true,
"hosts": [],
"id": 902,
"item_count": 0,
"items": [],
"mode": "all",
"reference": 4821,
"source": "deployment",
"status": "succeeded",
"trigger": "deployment",
"via": null
}
],
"sampled_at": "2026-11-06T08:55:00Z",
"stale": false,
"to": "2026-11-06T09:00:00Z",
"totals": {
"backend_errors": 0,
"backend_fetches": 20160,
"bytes_free": 402653184,
"bytes_used": 268435456,
"evictions": 0,
"hit_ratio": 0.9,
"hit_ratio_7d": 0.88,
"hits": 129600,
"misses": 14400,
"missing": [],
"objects": 4200,
"pass_ratio": 0.04,
"passes": 5760,
"peak_requests_per_s": 6.2,
"requests": 149760,
"requests_per_s": 1.73,
"resets": 0,
"storage_bytes": 671088640,
"transient_bytes": 1048576
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "varnish_not_offered",
"message": "Varnish is available for Magento 2 sites only.",
"reason": "varnish_not_offered"
}{
"code": "invalid",
"errors": {
"range": [
"range must be 1h, 24h or 7d."
]
},
"field": "range",
"message": "range must be 1h, 24h or 7d.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}