CorefinityCorefinityDocs
Open the Control PanelControl Panel
Operations · 1 of 4

Get an operation

Answers one operation: its status, steps and, when it failed, why. Read it every few seconds until status is completed or failed. A CoreCluster's own operations are read here too.

GET/api/corestack/operations/{operation}

Path parameters

operationintegerRequired

The id of an operation. Digits only. At least 1.

Returns

200 The operation.

Fields of the 200 answer
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
safety_snapshot_idinteger or null

The id of the snapshot a copy took of its target before replacing it; null when it took none. Sent only for a copy onto an existing environment, while fast copies onto existing environments are on. At least 1.

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/operations/5120 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "applied_at": null,
  "can_retry": true,
  "cluster": {
    "id": 1017,
    "name": "Northwind UK 1"
  },
  "committed_at": "2026-11-03T09:12:05Z",
  "completed_at": null,
  "created_at": "2026-11-03T09:12:03Z",
  "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": "The change was not applied within 15 minutes — staff have been notified",
  "failure_reason": "step_failed",
  "from_version": null,
  "hot": false,
  "id": 5120,
  "install": null,
  "label": "Site URL updated",
  "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": "failed",
  "status_label": "Failed",
  "step": "rewritten",
  "steps": [
    {
      "key": "committed",
      "label": "New address added",
      "state": "done"
    },
    {
      "key": "rewritten",
      "label": "Site URL updated",
      "state": "failed"
    },
    {
      "key": "finalising",
      "label": "Redirect saved",
      "state": "todo"
    },
    {
      "key": "finalised",
      "label": "Old address redirects",
      "state": "todo"
    }
  ],
  "subject": null,
  "summary": "Primary URL",
  "to_version": null,
  "type": "url_change",
  "type_label": "Primary URL"
}
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