CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 13 of 18

Get a new site's progress

The stages of a site's create, with its state. It never shows the new site's admin login. A site that no create made answers 404.

GET/api/corestack/sites/{site}/progress

Path parameters

siteintegerRequired

The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.

Returns

200 The create's progress.

Fields of the 200 answer
capacityobject or null

What the create is waiting for while capacity is being added.

clusterobject or null

The cluster the site is created in.

elapsed_secondsinteger or null
environmentsarray of objects

The progress of each environment created with the site.

failedobject or null
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
paymentobject or nullRequired

Null unless the site was created before your company had a payment method. Then add_by is the date to add one by and message says so in plain words.

requestedobject or any or nullRequired
retriedobject or any or nullRequired

The same for a retry of the create, or null.

siteobjectRequired

A site or environment row as lists and progress answers show it. Other fields may be present; the ones named here are always sent.

Fields
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
stagesarray of objectsRequired
Fields of each item
atstring or nullRequired
detailstring or nullRequired
keystringRequired
labelstringRequired
statestringRequired

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

statestringRequired
creatingcapacity_being_addedreadyfailed

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/sites/1042/progress \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "capacity": null,
  "cluster": {
    "id": 1009,
    "name": "CoreStack"
  },
  "elapsed_seconds": 42,
  "environments": [],
  "failed": null,
  "operation": {
    "completed_at": null,
    "created_at": "2026-11-14T09:00:00Z",
    "error": null,
    "id": 5100,
    "scope": "site",
    "status": "executing",
    "status_label": "Running",
    "steps": [
      {
        "key": "reserved",
        "label": "Port and address reserved",
        "state": "done"
      }
    ],
    "type": "provision",
    "type_label": "New site"
  },
  "order": null,
  "payment": null,
  "requested": {
    "at": "2026-11-14T09:00:00+00:00",
    "by": {
      "id": 2041,
      "name": "Eleanor Finch"
    }
  },
  "retried": null,
  "site": {
    "domain": "harbourandfinch.example.com",
    "health": "unknown",
    "id": 1042,
    "kind": "corestack",
    "limits": {
      "cpu_millicores": 2000,
      "disk_bytes": 10737418240,
      "memory_bytes": 4294967296
    },
    "mariadb": {
      "version": "11.8"
    },
    "mode": "staging",
    "mode_label": "No domain",
    "operation": null,
    "php": {
      "version": "8.3"
    },
    "primary_url": null,
    "removed": false,
    "tier": "S",
    "usage": {
      "cpu_millicores": null,
      "disk_used_bytes": null,
      "memory_bytes": null,
      "observed_at": null,
      "source": null
    }
  },
  "stages": [
    {
      "at": "2026-11-14T09:00:00+00:00",
      "detail": null,
      "key": "requested",
      "label": "Requested",
      "state": "done"
    },
    {
      "at": "2026-11-14T09:00:02+00:00",
      "detail": null,
      "key": "placed",
      "label": "Server assigned",
      "state": "done"
    },
    {
      "at": "2026-11-14T09:00:05+00:00",
      "detail": null,
      "key": "committed",
      "label": "Committed",
      "state": "done"
    },
    {
      "at": null,
      "detail": null,
      "key": "starting",
      "label": "Starting",
      "state": "current"
    },
    {
      "at": null,
      "detail": null,
      "key": "installing",
      "label": "Installing WordPress",
      "state": "todo"
    },
    {
      "at": null,
      "detail": null,
      "key": "environments",
      "label": "Environments",
      "state": "skipped"
    },
    {
      "at": null,
      "detail": null,
      "key": "ready",
      "label": "Ready",
      "state": "todo"
    }
  ],
  "state": "creating"
}
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