Get a site's Varnish
Answers whether Varnish is on, its version and the versions the site may use, its share of the site's memory, whether Magento is set up for it, and the purges left this hour.
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.
Returns
200 The site's Varnish.
Fields of the 200 answer
The latest sampled figures. Null until the site has been sampled.
Whether Magento's own cache settings match.
Fields
Format: date-time.
varnishbuiltinneeds_repairpending_codenullVarnish's share of the site's memory, in MiB.
Whether the site can use Varnish yet.
Whether somebody switched Varnish off for the site.
Fields of each item
Whether the site may move to it. False for the current version, which it already runs.
Why it is not allowed; for the current version, that it is the current one.
Where the version stands, such as lts, eol or prerelease.
The switch or version change that is still running: its type, what it changes to (on or off for a switch, the version for a version change) and the operation to follow. Null when none is.
The site's purges.
Fields
Seconds until the next purge may be asked for. 0 while any are left.
The latest purge, whoever or whatever sent it. Null when there has been none.
Redis's memory, in MiB, with Varnish on and off. Null when the site's size cannot be told.
Fields
At least 1.
The cache size, in MiB.
When somebody switched it off, as at. Null otherwise.
The Varnish version. While Varnish is off, the one the site had last; a switch-on without version uses it while it is still allowed for the site, and default_version otherwise.
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. |
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 \
-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');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/varnish', {
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",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"default_version": "7.7",
"enabled": true,
"live": null,
"magento_config": {
"checked_at": "2026-11-06T09:00:12Z",
"state": "varnish"
},
"memory_mib": 1280,
"offered": true,
"opt_out": false,
"options": [
{
"allowed": true,
"current": false,
"reason": null,
"status": "eol",
"version": "8.0"
},
{
"allowed": false,
"current": true,
"reason": "This is the current version",
"status": "eol",
"version": "7.7"
},
{
"allowed": true,
"current": false,
"reason": null,
"status": "lts",
"version": "6.0"
}
],
"pending": null,
"purge": {
"available_in": 0,
"last": {
"at": "2026-11-06T09:16:40Z",
"by": "Eleanor Finch",
"count": 2,
"items": [
"cat_p_1180",
"cat_c_27"
],
"mode": "tags",
"origin": "api",
"status": "succeeded"
},
"limit_per_hour": 10,
"remaining_this_hour": 9
},
"redis_mib": {
"off": 768,
"on": 512
},
"site": {
"domain": "harbourandfinch.example.com",
"environment": "Production",
"id": 1042
},
"storage_mib": 640,
"switched_off": null,
"version": "7.7"
}{
"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": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}