Get a CoreCluster's create progress
How far the CoreCluster's create has got, stage by stage, with its first sites. Read it again until the operation's status is completed or failed. It keeps answering after the create has finished.
Path parameters
The id of a CoreCluster. Digits only. At least 1.
Returns
200 The progress of the create.
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.
A sentence about how long the create usually takes, when there is one.
Roughly how long is left. Null when there is no estimate.
Set when the create has failed. Null otherwise.
Fields
Always false. Delete the CoreCluster and create it again, or contact support.
The key of the stage the create failed on.
A change the Control Panel is making or has made. A save or an action that starts work answers one in operation; read it again by id with GET / until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.
Fields
The cluster the operation runs on.
Why the operation failed, in plain words. Null unless status is failed.
A stable code for the failure.
True when the change applies without a maintenance window.
What the operation did differently on purpose. Empty when nothing.
Fields of each item
Who asked for the change.
Present on some site creations and copies.
Always null here. A one-time result is read once with the reveal endpoint.
nonependingavailableviewedWhat a retry needs first, if anything.
Who revealed a one-time result and when, when there was one.
siteclusterbatchThe website the operation belongs to. Null for a cluster's own operation.
Where a change is. completed and failed are final; every other status means the change is still running and blocks another change to the same site.
pendingcommittedrolling_outexecutingcompletedfailedThe key of the step the operation is at. Null once it has completed.
Fields of each item
One of done, current, todo, failed or skipped.
The kind of change, such as crons_change or redirects_change.
The order that created the CoreCluster, when one did. Null otherwise.
Set while a step that failed is being tried again automatically. Null otherwise.
Fields
At least 1.
How many attempts the step gets. Null when it is tried until the create's own time limit.
Format: date-time.
Format: date-time.
The key of the stage being tried again.
The first sites, each with its own operation and progress.
Fields of each item
A change the Control Panel is making or has made. A save or an action that starts work answers one in operation; read it again by id with GET / until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.
Fields
The cluster the operation runs on.
Why the operation failed, in plain words. Null unless status is failed.
A stable code for the failure.
True when the change applies without a maintenance window.
What the operation did differently on purpose. Empty when nothing.
Fields of each item
Who asked for the change.
Present on some site creations and copies.
Always null here. A one-time result is read once with the reveal endpoint.
nonependingavailableviewedWhat a retry needs first, if anything.
Who revealed a one-time result and when, when there was one.
siteclusterbatchThe website the operation belongs to. Null for a cluster's own operation.
Where a change is. completed and failed are final; every other status means the change is still running and blocks another change to the same site.
pendingcommittedrolling_outexecutingcompletedfailedThe key of the step the operation is at. Null once it has completed.
Fields of each item
One of done, current, todo, failed or skipped.
The kind of change, such as crons_change or redirects_change.
The site's own create progress. Null until the site's create has been picked up.
Fields
At least 1.
The stages of the create, in order. A CoreCluster with no first sites skips the site stages.
Fields of each item
Such as done, current, todo, skipped or failed.
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 | feature_off | This feature is not on for your organisation yet. |
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/progress \
-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/progress');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/progress', {
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/progress",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"cluster": {
"actions": {
"create_environment": {
"available": false,
"reason": "This cluster is still being created"
},
"create_site": {
"available": false,
"reason": "This cluster is still being created"
},
"delete": {
"available": false,
"reason": "This cluster is still being created"
},
"upgrade_package": {
"available": false,
"downgrade": false,
"reason": "This cluster is still being created"
}
},
"allowance": {
"cpu_millicores": 4000,
"disk_bytes": 214748364800,
"memory_bytes": 17179869184
},
"capacity": {
"basis": "estimate",
"cpu": {
"capacity_millicores": 4000,
"level": "ok",
"percent": 0,
"used_p95_millicores": 0
},
"evaluated_at": null,
"level": "ok",
"memory": {
"capacity_bytes": 17179869184,
"level": "ok",
"percent": 0,
"used_p95_bytes": 0
},
"package": {
"cores": 4,
"key": "xsmall",
"memory_bytes": 17179869184,
"name": "Extra small"
},
"sites": {
"count": 0,
"environments": 0
},
"storage": {
"capacity_bytes": 214748364800,
"level": "ok",
"percent": 0,
"provisioned_bytes": 0
}
},
"created_at": "2026-11-14T10:00:00Z",
"created_by": {
"id": 2041,
"name": "Eleanor Finch"
},
"environments": 0,
"id": 1018,
"kind": "customer",
"label": "Northwind UK 2",
"location": {
"arch": "arm64",
"label": "London (europe-west2)"
},
"logs": null,
"name": "Northwind UK 2",
"operation": {
"id": 5130,
"scope": "cluster",
"status": "committed",
"status_label": "Waiting for the platform",
"summary": "New cluster",
"to_version": null,
"type": "cluster_create",
"type_label": "New cluster"
},
"package": {
"cores": 4,
"key": "xsmall",
"name": "Extra small"
},
"pending_changes": {
"count": 0,
"window_starts_at": null
},
"ready_at": null,
"region": {
"key": "uk",
"label": "United Kingdom",
"place": "London (europe-west2)"
},
"reserved": {
"cpu_limit_millicores": 0,
"cpu_request_millicores": 0,
"disk_bytes": 0,
"memory_limit_bytes": 0,
"memory_request_bytes": 0
},
"sites": {
"applying": 0,
"degraded": 0,
"down": 0,
"environments": 0,
"healthy": 0,
"live": 0,
"preview": 0,
"total": 0,
"unknown": 0
},
"slug": "northwind-uk-2",
"snapshots": {
"frequency": "6h",
"over_quota": false,
"pruned_recently": false,
"quota_bytes": 429496729600,
"retention_days": 30,
"usage_bytes": null
},
"ssh_host": "ssh-northwind-uk-2.example.net",
"state": "creating",
"state_label": "Creating",
"state_reason": null,
"synced": {
"inventory_at": "2026-11-14T10:00:00Z",
"live_at": null,
"usage_at": null
},
"usage": {
"cpu_millicores": null,
"disk_used_bytes": null,
"memory_bytes": null,
"observed_at": null,
"source": null
}
},
"copy": null,
"elapsed_seconds": 42,
"eta_seconds": null,
"failed": null,
"operation": {
"applied_at": null,
"can_retry": false,
"cluster": {
"id": 1018,
"name": "Northwind UK 2"
},
"committed_at": "2026-11-14T10:00:01Z",
"completed_at": null,
"created_at": "2026-11-14T10:00:00Z",
"environment": null,
"error": null,
"failure_reason": null,
"from_version": null,
"hot": false,
"id": 5130,
"install": null,
"label": "SSH gateway ready",
"notes": [],
"parent_operation_id": null,
"requested_by": {
"id": 2041,
"name": "Eleanor Finch"
},
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"scope": "cluster",
"site": null,
"status": "committed",
"status_label": "Publishing the SSH gateway",
"step": "gateway_ready",
"steps": [
{
"key": "requested",
"label": "Requested",
"state": "done"
},
{
"key": "gateway_ready",
"label": "SSH gateway ready",
"state": "current"
},
{
"key": "ready",
"label": "Ready",
"state": "todo"
}
],
"subject": null,
"summary": "New cluster",
"to_version": null,
"type": "cluster_create",
"type_label": "New cluster"
},
"order": null,
"retrying": null,
"sites": [],
"stages": [
{
"at": "2026-11-14T10:00:00+00:00",
"detail": null,
"key": "requested",
"label": "Requested",
"state": "done"
},
{
"at": null,
"detail": null,
"key": "gateway_ready",
"label": "SSH gateway ready",
"state": "current"
},
{
"at": null,
"detail": null,
"key": "sites_scheduled",
"label": "Sites scheduled",
"state": "skipped"
},
{
"at": null,
"detail": null,
"key": "images_pulled",
"label": "Images pulled",
"state": "skipped"
},
{
"at": null,
"detail": null,
"key": "installing",
"label": "Installing",
"state": "skipped"
},
{
"at": null,
"detail": null,
"key": "ready",
"label": "Ready",
"state": "todo"
}
]
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}