Get the overview
The Managed Clusters overview: your CoreClusters with their usage, and whatever else the overview shows for your company.
Returns
200 The overview.
Fields of the 200 answer
Fields of each item
A path in the Control Panel.
The kind, a colon and a number, such as operation:77120.
operationcommanddeploymentrestoresnapshotterminalpagespeedauditcopymcppanelnullWhat the item is about, by type and id.
What needs attention now, the most pressing first.
Fields of each item
A path in the Control Panel.
The stable item id, such as site_down:1051.
Format: date-time.
Fields of each item
A path in the Control Panel.
The stable item id, such as site_down:1051.
Format: date-time.
Fields of each item
At least 1.
How many sites the CoreCluster has, in total and by health.
Format: date-time.
The PageSpeed strip. Null while PageSpeed is off for your company.
Fields of each item
healthydegradeddownapplyingunknownnot_liveFields
customer for a site in one of your CoreClusters, platform for a standalone CoreStack site.
The site row id, the {site} of every /corestack/sites/{site} endpoint.
On a read (a site, the list of sites, a CoreCluster's sites, the overview): corecluster for a site in one of your CoreClusters, corestack for a standalone CoreStack site. The answer to a change that carries the row, such as creating a site, can send corestack for either; hosting.cluster_kind tells the two apart on every answer.
coreclustercorestackFields
Fields
production once a domain is attached, staging before.
productionstagingunknownThe change running on the row now, or null.
The package of a standalone CoreStack site, with its key, code and name. Null for a CoreCluster site.
The changes waiting for the row's next maintenance window.
Fields
Fields
Fields
The row's own address on the platform.
The restore running on the row now, or null.
The site the row belongs to. For a production row, the row itself.
The row's platform identifier.
A summary of the row's snapshots.
Fields
The size of the row, such as S, M or L.
The size of a staging environment. Null for a production row.
Fields
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. |
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/overview \
-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/overview');
$data = $response->json();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);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{
"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": []
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}