---
title: "Get a site's Varnish"
url: https://docs.corefinity.com/api/reference/varnish/get-site-varnish
type: endpoint
last_updated: 2026-11-13
feature: varnish
related:
  - https://docs.corefinity.com/guides/sites/software-and-services/varnish.md
  - https://docs.corefinity.com/mcp/tools/corestack_varnish_get.md
---
# 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.

```http
GET /api/corestack/sites/{site}/varnish
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 120 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites/1042/varnish \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
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();
```

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 200 The site's Varnish.

```json
{
  "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"
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 The site is not a Magento 2 site (`varnish_not_offered`).

```json
{
  "code": "varnish_not_offered",
  "message": "Varnish is available for Magento 2 sites only.",
  "reason": "varnish_not_offered"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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`. |

## The same task elsewhere

- Guide: [Varnish](https://docs.corefinity.com/guides/sites/software-and-services/varnish.md)
- MCP tool: [`corestack_varnish_get`](https://docs.corefinity.com/mcp/tools/corestack_varnish_get.md)
