Get a purge or a repair's progress
Answers a Varnish purge or a repair of Magento's cache settings on this site. Read it again until status is no longer queued or running.
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.
The id of a purge or a repair of this site, from its command.id. At least 1.
Returns
200 The command.
Fields of the 200 answer
Why it failed, in plain words.
Format: date-time.
At least 1.
What was asked for. For a purge: its mode, the items it names and where the request came from (via). Null for a repair.
Fields
The one host the purge was limited to, when it was.
alltagsurlspatternsAlways varnish for a purge.
Where the purge was asked for, such as api.
varnish_purgemagento_varnish_configFormat: date-time.
What the command did. For a purge: the requests sent, how many were needed (requests) and whether Varnish confirmed them. For a repair: the cache Magento was set up for (mode: varnish or builtin) and whether anything had to be changed. Null until it finishes.
Fields
For a repair: whether Magento's settings had to be changed.
How many items the purge named; 1 for everything.
For a purge, its mode. For a repair, varnish or builtin: the cache Magento's settings now name.
Present only when the purge has something to warn about: a pattern broad enough to empty most of the cache, or an address too long to purge with its query variants, of which only the exact address was purged.
A site by its id and domain.
Fields
Format: date-time.
queued or running while it runs, then succeeded or failed.
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. |
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/commands/1 \
-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/commands/1');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/varnish/commands/1', {
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/commands/1",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"blocked_until_verified": false,
"duration_ms": 840,
"error": null,
"exit_code": 0,
"finished_at": "2026-11-06T09:16:41Z",
"id": 905,
"input": {
"host": null,
"mode": "tags",
"tags": [
"cat_p_1180",
"cat_c_27"
],
"target": "varnish",
"via": "api"
},
"kind": "varnish_purge",
"label": "Varnish purged · by tag",
"operation_id": null,
"output_excerpt": "200",
"queued_at": "2026-11-06T09:16:40Z",
"requested_by": {
"id": 2041,
"name": "Eleanor Finch"
},
"result": {
"confirmed": true,
"count": 2,
"hosts": [],
"mode": "tags",
"objects": null,
"requests": 1,
"seconds": 0,
"sent": 1,
"target": "varnish"
},
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"started_at": "2026-11-06T09:16:40Z",
"status": "succeeded",
"status_label": "Done"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}