CorefinityCorefinityDocs
Open the Control PanelControl Panel
CoreCluster · 4 of 10

Get a CoreCluster

One CoreCluster with every site on it. Each site carries its environments; a site removed from the CoreCluster is not listed.

GET/api/corestack/clusters/{cluster}

Path parameters

clusterintegerRequired

The id of a CoreCluster. Digits only. At least 1.

Returns

200 The CoreCluster and its sites.

Fields of the 200 answer
clusterobjectRequired

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
actionsobjectRequired

What can be done with the CoreCluster now.

Fields
create_environmentobjectRequired

Whether something can be done now and, when it cannot, why not.

Fields
availablebooleanRequired
reasonstring or nullRequired
create_siteobjectRequired

May add grows, true when the CoreCluster is full and would grow first under automatic upgrades.

Fields
availablebooleanRequired
reasonstring or nullRequired
deleteobjectRequired

Whether something can be done now and, when it cannot, why not.

Fields
availablebooleanRequired
reasonstring or nullRequired
upgrade_packageobjectRequired

Adds downgrade, true when a smaller package can be chosen.

Fields
availablebooleanRequired
reasonstring or nullRequired
allowanceobjectRequired

What the package allows.

Fields
cpu_millicoresinteger or null
disk_bytesinteger or null
memory_bytesinteger or null
billingobject

Sent only by GET /corestack/clusters/{cluster}, while billing is on for your company.

Fields
account_idinteger or nullRequired

The billing account the CoreCluster is charged to. Null when nothing charges it yet, or you cannot see the account. At least 1.

capacityobjectRequired

How much of the package the CoreCluster's sites use.

Fields
basisstringRequired

What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).

p95mixedestimate
cpuobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_millicoresinteger
used_p95_millicoresnumber or null
evaluated_atstring or nullRequired

Format: date-time.

levelstringRequired

The worst level of the meters.

okwarningblocked
memoryobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
used_p95_bytesnumber or null
packageobject or nullRequired

The package the figures are measured against. Null for a CoreCluster with no package.

Fields
coresinteger
keystring
memory_bytesinteger
namestring
sitesobjectRequired
Fields
countintegerRequired
environmentsintegerRequired
storageobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
provisioned_bytesnumber or null
created_atstring or nullRequired

Format: date-time.

created_byobject or any or nullRequired
environmentsintegerRequired

How many environments besides production the CoreCluster has.

idintegerRequired

The {cluster} of every /corestack/clusters/{cluster} endpoint. At least 1.

kindstringRequired

customer for a CoreCluster of your own.

customerplatform
labelstringRequired
locationobjectRequired
Fields
archstring
arm64amd64
labelstring

Where the CoreCluster runs.

logsobject or nullRequired

How much log storage the CoreCluster uses. Null when its logs are not collected.

namestringRequired
operationobject or any or nullRequired

The change running on the CoreCluster now, or the one that left it failed. Null otherwise.

packageobject or nullRequired

The CoreCluster's package. Null when it has none, and while packages are off for your company.

Fields
coresinteger
keystring
namestring
pending_changesobjectRequired

The changes waiting for the next maintenance window of the CoreCluster's sites.

Fields
countinteger
window_starts_atstring or null

Format: date-time.

ready_atstring or nullRequired

Format: date-time.

regionobjectRequired
Fields
keystringRequired

The region key, as a create takes it.

labelstringRequired
placestringRequired
reservedobjectRequired

What the sizes of the CoreCluster's sites add up to.

Fields
cpu_limit_millicoresinteger
cpu_request_millicoresinteger
disk_bytesinteger
memory_limit_bytesinteger
memory_request_bytesinteger
sitesobjectRequired

How many sites the CoreCluster has, and how they are doing.

Fields
applyingintegerRequired
degradedintegerRequired
downintegerRequired
environmentsintegerRequired

Environments besides production.

healthyintegerRequired
liveintegerRequired

Sites with a domain attached.

previewintegerRequired

Sites with no domain attached yet.

totalintegerRequired
unknownintegerRequired
slugstringRequired

Made from the name when the CoreCluster is created. It never changes.

snapshotsobjectRequired

The short form of the CoreCluster's snapshot settings and storage.

Fields
frequencystring
over_quotaboolean
pruned_recentlyboolean
quota_bytesinteger or null
retention_daysinteger or null
usage_bytesinteger or null
ssh_hoststringRequired

The address the CoreCluster's sites are reached on over SSH.

statestringRequired
creatingreadydegradedmigratingdeletingfailed
state_labelstringRequired
state_reasonstring or nullRequired

Why the CoreCluster is degraded, migrating or failed, in plain words.

syncedobjectRequired

When the list of sites, the usage and the live status were last read.

Fields
inventory_atstring or null

Format: date-time.

live_atstring or null

Format: date-time.

usage_atstring or null

Format: date-time.

usageobjectRequired

What the sites use now. A figure is null where nothing was measured.

Fields
cpu_millicoresnumber or null
disk_used_bytesnumber or null
memory_bytesnumber or null
observed_atstring or null

Format: date-time.

sourcestring or null
sitesarray of objectsRequired
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
environment_countintegerRequired

How many environments the site has besides production.

environmentsarray of objectsRequired

Every row of the site, the production row first.

Fields of each item
env_idstringRequired

The environment's platform identifier.

hostnamestringRequired

The environment's own address on the platform.

idintegerRequired

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

namestringRequired
rolestringRequired

The environment's role, such as production or staging.

role_labelstringRequired
slugstringRequired

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.
404noneCheck the id. You see only what your account can reach.
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/clusters/1017 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "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"
      }
    }
  ]
}
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