---
title: "Get a CoreCluster"
url: https://docs.corefinity.com/api/reference/corecluster/get-cluster
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_get.md
---
# Get a CoreCluster

One CoreCluster with every site on it. Each site carries its environments; a site removed from the
CoreCluster is not listed.

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

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 60 a minute
- Try it in the console: on

## Path parameters

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

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/clusters/1017 \
  -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');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017', {
  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",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The CoreCluster and its sites.

```json
{
  "cluster": {
    "actions": {
      "create_environment": {
        "available": true,
        "reason": null
      },
      "create_site": {
        "available": true,
        "reason": null
      },
      "delete": {
        "available": true,
        "reason": null
      },
      "upgrade_package": {
        "available": true,
        "downgrade": false,
        "reason": null
      }
    },
    "allowance": {
      "cpu_millicores": 4000,
      "disk_bytes": 214748364800,
      "memory_bytes": 17179869184
    },
    "capacity": {
      "basis": "p95",
      "cpu": {
        "capacity_millicores": 4000,
        "level": "ok",
        "percent": 6,
        "used_p95_millicores": 240
      },
      "evaluated_at": "2026-11-14T09:50:00Z",
      "level": "ok",
      "memory": {
        "capacity_bytes": 17179869184,
        "level": "ok",
        "percent": 6,
        "used_p95_bytes": 1073741824
      },
      "package": {
        "cores": 4,
        "key": "xsmall",
        "memory_bytes": 17179869184,
        "name": "Extra small"
      },
      "sites": {
        "count": 1,
        "environments": 0
      },
      "storage": {
        "capacity_bytes": 214748364800,
        "level": "ok",
        "percent": 5,
        "provisioned_bytes": 10737418240
      }
    },
    "created_at": "2026-11-02T08:14:00Z",
    "created_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "environments": 0,
    "id": 1017,
    "kind": "customer",
    "label": "Northwind UK 1",
    "location": {
      "arch": "arm64",
      "label": "London (europe-west2)"
    },
    "logs": null,
    "name": "Northwind UK 1",
    "operation": null,
    "package": {
      "cores": 4,
      "key": "xsmall",
      "name": "Extra small"
    },
    "pending_changes": {
      "count": 0,
      "window_starts_at": null
    },
    "ready_at": "2026-11-02T08:19:00Z",
    "region": {
      "key": "uk",
      "label": "United Kingdom",
      "place": "London (europe-west2)"
    },
    "reserved": {
      "cpu_limit_millicores": 2000,
      "cpu_request_millicores": 100,
      "disk_bytes": 10737418240,
      "memory_limit_bytes": 4294967296,
      "memory_request_bytes": 536870912
    },
    "sites": {
      "applying": 0,
      "degraded": 0,
      "down": 0,
      "environments": 0,
      "healthy": 1,
      "live": 1,
      "preview": 0,
      "total": 1,
      "unknown": 0
    },
    "slug": "northwind-uk-1",
    "snapshots": {
      "frequency": "6h",
      "over_quota": false,
      "pruned_recently": false,
      "quota_bytes": 429496729600,
      "retention_days": 30,
      "usage_bytes": 1288490188
    },
    "ssh_host": "ssh-northwind.example.net",
    "state": "ready",
    "state_label": "Ready",
    "state_reason": null,
    "synced": {
      "inventory_at": "2026-11-14T09:55:00Z",
      "live_at": "2026-11-14T09:58:00Z",
      "usage_at": "2026-11-14T09:55:00Z"
    },
    "usage": {
      "cpu_millicores": 180,
      "disk_used_bytes": 2362232012,
      "memory_bytes": 912261120,
      "observed_at": "2026-11-14T09:58:00Z",
      "source": "live"
    }
  },
  "sites": [
    {
      "compute_family": "general",
      "domain": "harbourandfinch.example.com",
      "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"
      },
      "environment_count": 0,
      "environments": [
        {
          "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"
        }
      ],
      "health": "healthy",
      "hosting": {
        "cluster_kind": "customer",
        "label": "CoreCluster Northwind UK 1"
      },
      "id": 1042,
      "kind": "corecluster",
      "limits": {
        "cpu_millicores": 2000,
        "disk_bytes": 10737418240,
        "memory_bytes": 4294967296
      },
      "logs": null,
      "mariadb": {
        "version": "11.8"
      },
      "mode": "production",
      "mode_label": "Domain attached",
      "operation": null,
      "package": null,
      "pending_changes": {
        "count": 0,
        "outcome_at": null,
        "state": null,
        "window_starts_at": null
      },
      "php": {
        "version": "8.3"
      },
      "platform": {
        "key": "wordpress",
        "label": "WordPress"
      },
      "platform_url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
      "primary_url": "https://harbourandfinch.example.com",
      "removed": false,
      "restore": null,
      "site": {
        "domain": "harbourandfinch.example.com",
        "id": 1042
      },
      "site_id": "rs-northwind-harbourandfinch-example-com",
      "snapshots": {
        "count": 2,
        "effective_frequency": "6h",
        "effective_label": "Every 6 hours",
        "latest": null,
        "latest_ready_at": "2026-11-14T06:05:00Z",
        "next_scheduled_at": "2026-11-14T12:05:00Z",
        "overridden": false,
        "stored_gb": 1.2
      },
      "tier": "S",
      "uat_size": null,
      "usage": {
        "cpu_millicores": 180,
        "disk_used_bytes": 2362232012,
        "memory_bytes": 912261120,
        "observed_at": "2026-11-14T09:58:00Z",
        "source": "live"
      }
    }
  ]
}
```

### 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 it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

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

## 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 |  | Check the id. You see only what your account can reach. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

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