CorefinityCorefinityDocs
Open the Control PanelControl Panel
CoreCluster · 5 of 10

Delete a CoreCluster

Deletes the CoreCluster for good, with its capacity and SSH address; read GET /corestack/clusters/{cluster}/deletion first. Without allow_non_empty only an empty CoreCluster is deleted; with it, every site, environment and deleted site in its grace period goes too, with no final snapshot, and so do their snapshots, except the ones the preview counts in kept_snapshots, which stay until their retention ends. The CoreCluster reads state deleting until it is gone, then answers 404.

DELETE/api/corestack/clusters/{cluster}

Path parameters

clusterintegerRequired

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

Body

allow_non_emptyboolean

True to delete everything that is still on the CoreCluster with it. Defaults to false.

confirm_namestringRequired

The CoreCluster's name, exactly.

Returns

202 The deletion has started. Poll the operation until it finishes.

Fields of the 202 answer
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

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.
409cluster_deletingThe cluster is being deleted. Nothing can be changed on it.
409cluster_not_emptyThe cluster still holds sites, environments or snapshots. Show the person what would be removed and call again only with their agreement.
409legacy_clusterCorefinity manages this cluster. Contact support to change its package or delete it.
409cluster_busyAnother change to the cluster is running. Wait for it to finish, then try again.
409staff_removalThe cluster holds something only Corefinity can remove. Contact support to delete it.
422confirm_mismatchSend the confirmation exactly as the field named in field asks for it.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.
502noneRead the message; it says what happened.
503switched_offCorefinity has switched this action off for the moment. Try again later.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X DELETE https://manage.corefinity.com/api/corestack/clusters/1017 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm_name": "Northwind spare"
  }'
{
  "operation": {
    "applied_at": null,
    "can_retry": false,
    "cluster": {
      "id": 1017,
      "name": "Northwind UK 1"
    },
    "committed_at": null,
    "completed_at": null,
    "created_at": "2026-11-14T10:00:00Z",
    "environment": null,
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5140,
    "install": null,
    "label": "Sites removed",
    "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": "pending",
    "status_label": "Removing the sites, 1 site left",
    "step": "sites_removed",
    "steps": [
      {
        "key": "requested",
        "label": "Requested",
        "state": "done"
      },
      {
        "key": "sites_removed",
        "label": "Sites removed",
        "state": "current"
      },
      {
        "key": "snapshots_deleted",
        "label": "Snapshots deleted",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "Delete cluster",
    "to_version": null,
    "type": "cluster_delete",
    "type_label": "Delete cluster"
  }
}
Try it

Try it is off for this endpointIt deletes data that cannot be brought back. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT