Get a CoreCluster
One CoreCluster with every site on it. Each site carries its environments; a site removed from the CoreCluster is not listed.
Path parameters
The id of a CoreCluster. Digits only. At least 1.
Returns
200 The CoreCluster and its sites.
Fields of the 200 answer
A CoreCluster. Every answer that carries a CoreCluster carries this object. Other fields may be present; the ones named in required are always sent.
Fields
What can be done with the CoreCluster now.
Fields
Whether something can be done now and, when it cannot, why not.
Fields
May add grows, true when the CoreCluster is full and would grow first under automatic upgrades.
Fields
Whether something can be done now and, when it cannot, why not.
Fields
Adds downgrade, true when a smaller package can be chosen.
Fields
What the package allows.
Fields
Sent only by GET /corestack/clusters/{cluster}, while billing is on for your company.
Fields
The billing account the CoreCluster is charged to. Null when nothing charges it yet, or you cannot see the account. At least 1.
How much of the package the CoreCluster's sites use.
Fields
What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).
p95mixedestimateOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedFormat: date-time.
The worst level of the meters.
okwarningblockedOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedThe package the figures are measured against. Null for a CoreCluster with no package.
Fields
Fields
One meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedFormat: date-time.
How many environments besides production the CoreCluster has.
The {cluster} of every /corestack/clusters/{cluster} endpoint. At least 1.
customer for a CoreCluster of your own.
customerplatformFields
arm64amd64Where the CoreCluster runs.
How much log storage the CoreCluster uses. Null when its logs are not collected.
The change running on the CoreCluster now, or the one that left it failed. Null otherwise.
The CoreCluster's package. Null when it has none, and while packages are off for your company.
Fields
The changes waiting for the next maintenance window of the CoreCluster's sites.
Fields
Format: date-time.
Format: date-time.
Fields
The region key, as a create takes it.
What the sizes of the CoreCluster's sites add up to.
Fields
How many sites the CoreCluster has, and how they are doing.
Fields
Environments besides production.
Sites with a domain attached.
Sites with no domain attached yet.
Made from the name when the CoreCluster is created. It never changes.
The short form of the CoreCluster's snapshot settings and storage.
Fields
The address the CoreCluster's sites are reached on over SSH.
creatingreadydegradedmigratingdeletingfailedWhy the CoreCluster is degraded, migrating or failed, in plain words.
When the list of sites, the usage and the live status were last read.
Fields
Format: date-time.
Format: date-time.
Format: date-time.
What the sites use now. A figure is null where nothing was measured.
Fields
Format: date-time.
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
How many environments the site has besides production.
Every row of the site, the production row first.
Fields of each item
The environment's platform identifier.
The environment's own address on the platform.
The site row id, the {site} every /corestack/sites/{site} endpoint takes.
The environment's role, such as production or staging.
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 | none | Check the id. You see only what your account can reach. |
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/clusters/1017 \
-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/clusters/1017');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017', {
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/clusters/1017",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"cluster": {
"actions": {
"create_environment": {
"available": true,
"reason": null
},
"create_site": {
"available": true,
"reason": null
},
"delete": {
"available": true,
"reason": null
},
"upgrade_package": {
"available": true,
"downgrade": false,
"reason": null
}
},
"allowance": {
"cpu_millicores": 4000,
"disk_bytes": 214748364800,
"memory_bytes": 17179869184
},
"capacity": {
"basis": "p95",
"cpu": {
"capacity_millicores": 4000,
"level": "ok",
"percent": 6,
"used_p95_millicores": 240
},
"evaluated_at": "2026-11-14T09:50:00Z",
"level": "ok",
"memory": {
"capacity_bytes": 17179869184,
"level": "ok",
"percent": 6,
"used_p95_bytes": 1073741824
},
"package": {
"cores": 4,
"key": "xsmall",
"memory_bytes": 17179869184,
"name": "Extra small"
},
"sites": {
"count": 1,
"environments": 0
},
"storage": {
"capacity_bytes": 214748364800,
"level": "ok",
"percent": 5,
"provisioned_bytes": 10737418240
}
},
"created_at": "2026-11-02T08:14:00Z",
"created_by": {
"id": 2041,
"name": "Eleanor Finch"
},
"environments": 0,
"id": 1017,
"kind": "customer",
"label": "Northwind UK 1",
"location": {
"arch": "arm64",
"label": "London (europe-west2)"
},
"logs": null,
"name": "Northwind UK 1",
"operation": null,
"package": {
"cores": 4,
"key": "xsmall",
"name": "Extra small"
},
"pending_changes": {
"count": 0,
"window_starts_at": null
},
"ready_at": "2026-11-02T08:19:00Z",
"region": {
"key": "uk",
"label": "United Kingdom",
"place": "London (europe-west2)"
},
"reserved": {
"cpu_limit_millicores": 2000,
"cpu_request_millicores": 100,
"disk_bytes": 10737418240,
"memory_limit_bytes": 4294967296,
"memory_request_bytes": 536870912
},
"sites": {
"applying": 0,
"degraded": 0,
"down": 0,
"environments": 0,
"healthy": 1,
"live": 1,
"preview": 0,
"total": 1,
"unknown": 0
},
"slug": "northwind-uk-1",
"snapshots": {
"frequency": "6h",
"over_quota": false,
"pruned_recently": false,
"quota_bytes": 429496729600,
"retention_days": 30,
"usage_bytes": 1288490188
},
"ssh_host": "ssh-northwind.example.net",
"state": "ready",
"state_label": "Ready",
"state_reason": null,
"synced": {
"inventory_at": "2026-11-14T09:55:00Z",
"live_at": "2026-11-14T09:58:00Z",
"usage_at": "2026-11-14T09:55:00Z"
},
"usage": {
"cpu_millicores": 180,
"disk_used_bytes": 2362232012,
"memory_bytes": 912261120,
"observed_at": "2026-11-14T09:58:00Z",
"source": "live"
}
},
"sites": [
{
"compute_family": "general",
"domain": "harbourandfinch.example.com",
"environment": {
"env_id": "rs-northwind-harbourandfinch-example-com",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1042,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"environment_count": 0,
"environments": [
{
"env_id": "rs-northwind-harbourandfinch-example-com",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1042,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
}
],
"health": "healthy",
"hosting": {
"cluster_kind": "customer",
"label": "CoreCluster Northwind UK 1"
},
"id": 1042,
"kind": "corecluster",
"limits": {
"cpu_millicores": 2000,
"disk_bytes": 10737418240,
"memory_bytes": 4294967296
},
"logs": null,
"mariadb": {
"version": "11.8"
},
"mode": "production",
"mode_label": "Domain attached",
"operation": null,
"package": null,
"pending_changes": {
"count": 0,
"outcome_at": null,
"state": null,
"window_starts_at": null
},
"php": {
"version": "8.3"
},
"platform": {
"key": "wordpress",
"label": "WordPress"
},
"platform_url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
"primary_url": "https://harbourandfinch.example.com",
"removed": false,
"restore": null,
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"site_id": "rs-northwind-harbourandfinch-example-com",
"snapshots": {
"count": 2,
"effective_frequency": "6h",
"effective_label": "Every 6 hours",
"latest": null,
"latest_ready_at": "2026-11-14T06:05:00Z",
"next_scheduled_at": "2026-11-14T12:05:00Z",
"overridden": false,
"stored_gb": 1.2
},
"tier": "S",
"uat_size": null,
"usage": {
"cpu_millicores": 180,
"disk_used_bytes": 2362232012,
"memory_bytes": 912261120,
"observed_at": "2026-11-14T09:58:00Z",
"source": "live"
}
}
]
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}