CorefinityCorefinityDocs
Open the Control PanelControl Panel
CoreCluster · 9 of 10

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.

GET/api/corestack/clusters/{cluster}/progress

Path parameters

clusterintegerRequired

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

Returns

200 The progress of the create.

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
copystring or null

A sentence about how long the create usually takes, when there is one.

elapsed_secondsinteger or nullRequired
eta_secondsinteger or nullRequired

Roughly how long is left. Null when there is no estimate.

failedobject or nullRequired

Set when the create has failed. Null otherwise.

Fields
can_retrybooleanRequired

Always false. Delete the CoreCluster and create it again, or contact support.

errorstringRequired
stagestringRequired

The key of the stage the create failed on.

operationobjectRequired

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 /corestack/operations/{operation} until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.

Fields
applied_atstring or null
can_retryboolean or null
clusterobject or any or null

The cluster the operation runs on.

committed_atstring or null
completed_atstring or nullRequired
created_atstring or nullRequired
environmentobject or any or null
errorstring or nullRequired

Why the operation failed, in plain words. Null unless status is failed.

failure_reasonstring or null

A stable code for the failure.

from_versionstring or null
hotboolean or null

True when the change applies without a maintenance window.

idintegerRequired
installobject or null
labelstring or null
notesarray of objects

What the operation did differently on purpose. Empty when nothing.

Fields of each item
codestringRequired
textstringRequired
parent_operation_idinteger or null
requested_byany

Who asked for the change.

reset_targetany

Present on some site creations and copies.

resultany

Always null here. A one-time result is read once with the reveal endpoint.

result_statestring
nonependingavailableviewed
retried_by_operation_idinteger or null
retries_operation_idinteger or null
retry_requiresany

What a retry needs first, if anything.

revealedany

Who revealed a one-time result and when, when there was one.

scopestringRequired
siteclusterbatch
siteobject or any or null

The website the operation belongs to. Null for a cluster's own operation.

statusstringRequired

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_outexecutingcompletedfailed
status_labelstringRequired
stepstring or null

The key of the step the operation is at. Null once it has completed.

stepsarray of objectsRequired
Fields of each item
keystring
labelstring
statestring

One of done, current, todo, failed or skipped.

subjectobject or null
summarystring or null
to_versionstring or null
typestringRequired

The kind of change, such as crons_change or redirects_change.

type_labelstringRequired
orderobject or null

The order that created the CoreCluster, when one did. Null otherwise.

retryingobject or nullRequired

Set while a step that failed is being tried again automatically. Null otherwise.

Fields
attemptintegerRequired

At least 1.

attemptsinteger or nullRequired

How many attempts the step gets. Null when it is tried until the create's own time limit.

messagestringRequired
next_attempt_atstring or nullRequired

Format: date-time.

sincestring or nullRequired

Format: date-time.

stagestringRequired

The key of the stage being tried again.

sitesarray of objectsRequired

The first sites, each with its own operation and progress.

Fields of each item
lifecyclestringRequired
operationobjectRequired

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 /corestack/operations/{operation} until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.

Fields
applied_atstring or null
can_retryboolean or null
clusterobject or any or null

The cluster the operation runs on.

committed_atstring or null
completed_atstring or nullRequired
created_atstring or nullRequired
environmentobject or any or null
errorstring or nullRequired

Why the operation failed, in plain words. Null unless status is failed.

failure_reasonstring or null

A stable code for the failure.

from_versionstring or null
hotboolean or null

True when the change applies without a maintenance window.

idintegerRequired
installobject or null
labelstring or null
notesarray of objects

What the operation did differently on purpose. Empty when nothing.

Fields of each item
codestringRequired
textstringRequired
parent_operation_idinteger or null
requested_byany

Who asked for the change.

reset_targetany

Present on some site creations and copies.

resultany

Always null here. A one-time result is read once with the reveal endpoint.

result_statestring
nonependingavailableviewed
retried_by_operation_idinteger or null
retries_operation_idinteger or null
retry_requiresany

What a retry needs first, if anything.

revealedany

Who revealed a one-time result and when, when there was one.

scopestringRequired
siteclusterbatch
siteobject or any or null

The website the operation belongs to. Null for a cluster's own operation.

statusstringRequired

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_outexecutingcompletedfailed
status_labelstringRequired
stepstring or null

The key of the step the operation is at. Null once it has completed.

stepsarray of objectsRequired
Fields of each item
keystring
labelstring
statestring

One of done, current, todo, failed or skipped.

subjectobject or null
summarystring or null
to_versionstring or null
typestringRequired

The kind of change, such as crons_change or redirects_change.

type_labelstringRequired
progressobject or any or nullRequired

The site's own create progress. Null until the site's create has been picked up.

siteobjectRequired
Fields
contentstringRequired
domainstringRequired
idintegerRequired

At least 1.

platformstringRequired
stagesarray of objectsRequired

The stages of the create, in order. A CoreCluster with no first sites skips the site stages.

Fields of each item
atstring or nullRequired
detailstring or nullRequired
keystringRequired
labelstringRequired
statestringRequired

Such as done, current, todo, skipped or failed.

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.
404feature_offThis feature is not on for your organisation yet.
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/progress \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "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"
    }
  ]
}
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