---
title: "Get the overview"
url: https://docs.corefinity.com/api/reference/sites/get-overview
type: endpoint
last_updated: 2026-11-13
feature: sites
related:
  - https://docs.corefinity.com/guides/sites/create-and-manage/site-overview.md
  - https://docs.corefinity.com/mcp/tools/corestack_overview_get.md
---
# Get the overview

The Managed Clusters overview: your CoreClusters with their usage, and whatever else the overview shows
for your company.

```http
GET /api/corestack/overview
```

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

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/overview \
  -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/overview');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/overview', {
  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/overview",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The overview.

```json
{
  "activity": [],
  "attention": [
    {
      "acknowledgeable": true,
      "acknowledged": null,
      "action": null,
      "cluster": {
        "id": 1017,
        "name": "Northwind UK 1"
      },
      "detail": "No container is ready.",
      "environment": null,
      "href": "/managed-clusters/sites/1051",
      "id": "site_down:1051",
      "kind": "site_down",
      "scope": "site",
      "severity": "critical",
      "since": "2026-11-14T08:58:00Z",
      "site": {
        "domain": "journal.harbourandfinch.example.com",
        "id": 1051
      },
      "subject": null,
      "title": "Site is down"
    }
  ],
  "attention_acknowledged": [],
  "attention_acknowledged_total": 0,
  "attention_total": 1,
  "clusters": [
    {
      "id": 1017,
      "kind": "customer",
      "label": "Northwind UK 1",
      "name": "Northwind UK 1",
      "region": {
        "key": "uk",
        "label": "United Kingdom",
        "place": "London (europe-west2)"
      },
      "sites": {
        "applying": 0,
        "degraded": 0,
        "down": 1,
        "environments": 1,
        "healthy": 1,
        "live": 1,
        "preview": 1,
        "total": 2,
        "unknown": 0
      },
      "slug": "northwind-uk-1",
      "state": "ready",
      "state_label": "Ready"
    }
  ],
  "generated_at": "2026-11-14T09:00:00Z",
  "pagespeed": null,
  "sites": []
}
```

### 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"
}
```

### 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. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Site overview](https://docs.corefinity.com/guides/sites/create-and-manage/site-overview.md)
- MCP tool: [`corestack_overview_get`](https://docs.corefinity.com/mcp/tools/corestack_overview_get.md)
