CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 7 of 18

Get the overview

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

GET/api/corestack/overview

Returns

200 The overview.

Fields of the 200 answer
activityarray of objects
Fields of each item
actorobject or any or null
atstringRequired
clusterobject or any or null
environmentobject or any or null
hrefstring or null

A path in the Control Panel.

idstringRequired

The kind, a colon and a number, such as operation:77120.

kindstringRequired
operationcommanddeploymentrestoresnapshotterminalpagespeedauditcopy
originstring or null
mcppanelnull
refobject or null

What the item is about, by type and id.

scopestring or null
siteobject or any or null
statusstring or nullRequired
status_labelstring or null
summarystring or null
titlestringRequired
unfinishedboolean
attentionarray of objects

What needs attention now, the most pressing first.

Fields of each item
acknowledgeablebooleanRequired
acknowledgedobject or any or nullRequired
actionobject or null
clusterobject or any or null
detailstring or null
environmentobject or any or null
hrefstring or null

A path in the Control Panel.

idstringRequired

The stable item id, such as site_down:1051.

kindstringRequired
scopestring or null
severitystringRequired
sincestring or null

Format: date-time.

siteobject or any or null
subjectobject or null
titlestringRequired
attention_acknowledgedarray of objects
Fields of each item
acknowledgeablebooleanRequired
acknowledgedobject or any or nullRequired
actionobject or null
clusterobject or any or null
detailstring or null
environmentobject or any or null
hrefstring or null

A path in the Control Panel.

idstringRequired

The stable item id, such as site_down:1051.

kindstringRequired
scopestring or null
severitystringRequired
sincestring or null

Format: date-time.

siteobject or any or null
subjectobject or null
titlestringRequired
attention_acknowledged_totalinteger
attention_totalinteger
clustersarray of objectsRequired
Fields of each item
actionsobject or null
allowanceobject or null
capacityobject or null
idintegerRequired

At least 1.

kindstring
labelstring
namestringRequired
operationobject or any or null
packageobject or null
pending_changesobject or null
regionobject or null
reservedobject or null
sitesobject or null

How many sites the CoreCluster has, in total and by health.

slugstring
statestring
state_labelstring
usageobject or null
generated_atstring

Format: date-time.

pagespeedobject or null

The PageSpeed strip. Null while PageSpeed is off for your company.

sitesarray of objects
Fields of each item
compute_familystring or null
domainstringRequired
environmentobject or any or null
healthstringRequired
healthydegradeddownapplyingunknownnot_live
hostingobject or null
Fields
cluster_kindstring

customer for a site in one of your CoreClusters, platform for a standalone CoreStack site.

labelstring
idintegerRequired

The site row id, the {site} of every /corestack/sites/{site} endpoint.

kindstringRequired

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.

coreclustercorestack
limitsobjectRequired
Fields
cpu_millicoresinteger or null
disk_bytesinteger or null
memory_bytesinteger or null
logsobject or null
mariadbobjectRequired
Fields
versionstring or null
modestringRequired

production once a domain is attached, staging before.

productionstagingunknown
mode_labelstringRequired
operationobject or any or nullRequired

The change running on the row now, or null.

packageobject or null

The package of a standalone CoreStack site, with its key, code and name. Null for a CoreCluster site.

pending_changesobject

The changes waiting for the row's next maintenance window.

Fields
countinteger
window_starts_atstring or null
phpobjectRequired
Fields
versionstring or null
platformobject
Fields
keystringRequired
labelstringRequired
platform_urlstring or null

The row's own address on the platform.

primary_urlstring or nullRequired
removedbooleanRequired
restoreobject or null

The restore running on the row now, or null.

siteobject or any or null

The site the row belongs to. For a production row, the row itself.

site_idstring

The row's platform identifier.

snapshotsobject

A summary of the row's snapshots.

Fields
countinteger
effective_frequencystring
effective_labelstring
latest_ready_atstring or null
next_scheduled_atstring or null
overriddenboolean
stored_gbnumber
tierstring or nullRequired

The size of the row, such as S, M or L.

uat_sizestring or null

The size of a staging environment. Null for a production row.

usageobjectRequired
Fields
cpu_millicoresnumber or null
disk_used_bytesnumber or null
memory_bytesnumber or null
observed_atstring or null
sourcestring or null

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
429rate_limitedWait 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"
{
  "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": []
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT