---
title: "Preview a CoreCluster's deletion"
url: https://docs.corefinity.com/api/reference/corecluster/preview-cluster-deletion
type: endpoint
last_updated: 2026-11-13
feature: clusters
related:
  - https://docs.corefinity.com/guides/corecluster/cluster-overview.md
  - https://docs.corefinity.com/mcp/tools/corecluster_delete_preflight.md
---
# 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.

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

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 60 a minute
- Try it in the console: off. It has not been cleared for the console. Copy the request and run it yourself when you are sure.

## Path parameters

- `cluster` (integer, required): The id of a CoreCluster. Digits only.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/clusters/1017/deletion \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/clusters/1017/deletion');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/deletion', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/clusters/1017/deletion",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 What the deletion would take.

```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
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

### 503 Corefinity has switched this action off for the moment. Try again later.

```json
{
  "code": "switched_off",
  "message": "Deleting is switched off at the moment",
  "reason": "switched_off",
  "switch": "delete"
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 503 | `switched_off` | Corefinity has switched this action off for the moment. Try again later. |

## The same task elsewhere

- Guide: [Cluster overview](https://docs.corefinity.com/guides/corecluster/cluster-overview.md)
- MCP tool: [`corecluster_delete_preflight`](https://docs.corefinity.com/mcp/tools/corecluster_delete_preflight.md)
