CorefinityCorefinityDocs
Open the Control PanelControl Panel
CoreCluster · 8 of 10

Preview a CoreCluster's deletion

What deleting the CoreCluster would take with it: totals, then each site with its environments and snapshots. empty is true when no site, environment, deleted site or snapshot is left. Nothing is deleted.

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

Path parameters

clusterintegerRequired

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

Returns

200 What the deletion would take.

Fields of the 200 answer
clusterobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired

The name confirm_name must match.

ssh_hoststring or nullRequired
emptybooleanRequired

True when there is no site, environment, deleted site in its grace period or snapshot.

kept_snapshotsobjectRequired

Snapshots the deletion leaves until their retention ends.

Fields
bytesintegerRequired
countintegerRequired
removed_sites_snapshotsobjectRequired

Snapshots of sites that were removed earlier, which the deletion deletes too.

Fields
bytesintegerRequired
countintegerRequired
sitesarray of objectsRequired

Up to 1,000 sites, the ones that are not deleted first, then by domain.

Fields of each item
deleted_atstring or nullRequired

Format: date-time.

domainstringRequired
environmentsarray of objectsRequired

Up to 50 of the site's environments.

Fields of each item
idintegerRequired

At least 1.

namestringRequired
environments_moreintegerRequired

How many more environments the site has than are listed.

idintegerRequired

At least 1.

snapshotsobjectRequired
Fields
bytesintegerRequired
countintegerRequired
statestringRequired
livedeleted
sites_moreintegerRequired

How many more sites there are than are listed.

totalsobjectRequired
Fields
deleted_sitesintegerRequired

Sites you deleted that are still in their grace period.

domainsintegerRequired
environmentsintegerRequired
mail_domainsintegerRequired
sitesintegerRequired
snapshot_bytesintegerRequired
snapshotsintegerRequired

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.
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 https://manage.corefinity.com/api/corestack/clusters/1017/deletion \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "cluster": {
    "id": 1017,
    "name": "Northwind UK 1",
    "ssh_host": "ssh-northwind.example.net"
  },
  "empty": false,
  "kept_snapshots": {
    "bytes": 0,
    "count": 0
  },
  "removed_sites_snapshots": {
    "bytes": 0,
    "count": 0
  },
  "sites": [
    {
      "deleted_at": null,
      "domain": "harbourandfinch.example.com",
      "environments": [],
      "environments_more": 0,
      "id": 1042,
      "snapshots": {
        "bytes": 1288490188,
        "count": 2
      },
      "state": "live"
    }
  ],
  "sites_more": 0,
  "totals": {
    "deleted_sites": 0,
    "domains": 1,
    "environments": 0,
    "mail_domains": 0,
    "sites": 1,
    "snapshot_bytes": 1288490188,
    "snapshots": 2
  }
}
Try it

Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT