CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 14 of 18

Get a CoreCluster site's install progress

The create operation of a site made in one of your CoreClusters, with its steps. It never shows the new site's admin login. A site that no create made answers 404.

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

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 install progress.

Fields of the 200 answer
credentialsany or nullRequired

Always null here. The login is revealed once, with its own endpoint.

credentials_statestringRequired

Whether a one-time admin login is waiting to be revealed.

nonependingavailableviewed
eta_secondsinteger 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
preview_credentials_notestring or null
reset_targetobject or null
revealedobject or null
seedobject or null
siteobjectRequired
Fields
contentstring or null

fresh for a new install, empty for an empty site.

domainstringRequired
idintegerRequired

At least 1.

platformstring
preview_urlstring or null
site_idstring

The site's name on the platform, such as rs-northwind-harbourandfinch-example-com.

ssh_portinteger or null

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/provisioning \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "credentials": null,
  "credentials_state": "none",
  "eta_seconds": null,
  "operation": {
    "applied_at": null,
    "can_retry": false,
    "cluster": {
      "id": 1017,
      "name": "Northwind UK 1"
    },
    "committed_at": "2026-11-14T09:00:05Z",
    "completed_at": "2026-11-14T09:03:40Z",
    "created_at": "2026-11-14T09:00:00Z",
    "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"
    },
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5100,
    "install": null,
    "notes": [],
    "parent_operation_id": null,
    "requested_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "reset_target": null,
    "result": null,
    "result_state": "none",
    "retried_by_operation_id": null,
    "retries_operation_id": null,
    "retry_requires": null,
    "revealed": null,
    "scope": "site",
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "status": "completed",
    "status_label": "Ready",
    "steps": [
      {
        "key": "reserved",
        "label": "Port and address reserved",
        "state": "done"
      }
    ],
    "subject": null,
    "summary": "New site harbourandfinch.example.com",
    "to_version": null,
    "type": "provision",
    "type_label": "New site"
  },
  "preview_credentials_note": "The platform hostname is open to the web and hidden from search engines; attach a domain when you are ready.",
  "reset_target": null,
  "revealed": null,
  "seed": null,
  "site": {
    "content": "empty",
    "domain": "harbourandfinch.example.com",
    "id": 1042,
    "platform": "wordpress",
    "preview_url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
    "site_id": "rs-northwind-harbourandfinch-example-com",
    "ssh_port": 20031
  }
}
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