---
title: "Get a CoreCluster's create progress"
url: https://docs.corefinity.com/api/reference/corecluster/get-cluster-progress
type: endpoint
last_updated: 2026-11-13
feature: cluster-create
related:
  - https://docs.corefinity.com/guides/corecluster/create-a-cluster.md
  - https://docs.corefinity.com/mcp/tools/corecluster_progress_get.md
---
# Get a CoreCluster's create progress

How far the CoreCluster's create has got, stage by stage, with its first sites. Read it again until the
operation's `status` is `completed` or `failed`. It keeps answering after the create has finished.

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

- 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/progress \
  -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/progress');

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

### Node

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

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

## Responses

### 200 The progress of the create.

```json
{
  "cluster": {
    "actions": {
      "create_environment": {
        "available": false,
        "reason": "This cluster is still being created"
      },
      "create_site": {
        "available": false,
        "reason": "This cluster is still being created"
      },
      "delete": {
        "available": false,
        "reason": "This cluster is still being created"
      },
      "upgrade_package": {
        "available": false,
        "downgrade": false,
        "reason": "This cluster is still being created"
      }
    },
    "allowance": {
      "cpu_millicores": 4000,
      "disk_bytes": 214748364800,
      "memory_bytes": 17179869184
    },
    "capacity": {
      "basis": "estimate",
      "cpu": {
        "capacity_millicores": 4000,
        "level": "ok",
        "percent": 0,
        "used_p95_millicores": 0
      },
      "evaluated_at": null,
      "level": "ok",
      "memory": {
        "capacity_bytes": 17179869184,
        "level": "ok",
        "percent": 0,
        "used_p95_bytes": 0
      },
      "package": {
        "cores": 4,
        "key": "xsmall",
        "memory_bytes": 17179869184,
        "name": "Extra small"
      },
      "sites": {
        "count": 0,
        "environments": 0
      },
      "storage": {
        "capacity_bytes": 214748364800,
        "level": "ok",
        "percent": 0,
        "provisioned_bytes": 0
      }
    },
    "created_at": "2026-11-14T10:00:00Z",
    "created_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "environments": 0,
    "id": 1018,
    "kind": "customer",
    "label": "Northwind UK 2",
    "location": {
      "arch": "arm64",
      "label": "London (europe-west2)"
    },
    "logs": null,
    "name": "Northwind UK 2",
    "operation": {
      "id": 5130,
      "scope": "cluster",
      "status": "committed",
      "status_label": "Waiting for the platform",
      "summary": "New cluster",
      "to_version": null,
      "type": "cluster_create",
      "type_label": "New cluster"
    },
    "package": {
      "cores": 4,
      "key": "xsmall",
      "name": "Extra small"
    },
    "pending_changes": {
      "count": 0,
      "window_starts_at": null
    },
    "ready_at": null,
    "region": {
      "key": "uk",
      "label": "United Kingdom",
      "place": "London (europe-west2)"
    },
    "reserved": {
      "cpu_limit_millicores": 0,
      "cpu_request_millicores": 0,
      "disk_bytes": 0,
      "memory_limit_bytes": 0,
      "memory_request_bytes": 0
    },
    "sites": {
      "applying": 0,
      "degraded": 0,
      "down": 0,
      "environments": 0,
      "healthy": 0,
      "live": 0,
      "preview": 0,
      "total": 0,
      "unknown": 0
    },
    "slug": "northwind-uk-2",
    "snapshots": {
      "frequency": "6h",
      "over_quota": false,
      "pruned_recently": false,
      "quota_bytes": 429496729600,
      "retention_days": 30,
      "usage_bytes": null
    },
    "ssh_host": "ssh-northwind-uk-2.example.net",
    "state": "creating",
    "state_label": "Creating",
    "state_reason": null,
    "synced": {
      "inventory_at": "2026-11-14T10:00:00Z",
      "live_at": null,
      "usage_at": null
    },
    "usage": {
      "cpu_millicores": null,
      "disk_used_bytes": null,
      "memory_bytes": null,
      "observed_at": null,
      "source": null
    }
  },
  "copy": null,
  "elapsed_seconds": 42,
  "eta_seconds": null,
  "failed": null,
  "operation": {
    "applied_at": null,
    "can_retry": false,
    "cluster": {
      "id": 1018,
      "name": "Northwind UK 2"
    },
    "committed_at": "2026-11-14T10:00:01Z",
    "completed_at": null,
    "created_at": "2026-11-14T10:00:00Z",
    "environment": null,
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5130,
    "install": null,
    "label": "SSH gateway ready",
    "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": "committed",
    "status_label": "Publishing the SSH gateway",
    "step": "gateway_ready",
    "steps": [
      {
        "key": "requested",
        "label": "Requested",
        "state": "done"
      },
      {
        "key": "gateway_ready",
        "label": "SSH gateway ready",
        "state": "current"
      },
      {
        "key": "ready",
        "label": "Ready",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "New cluster",
    "to_version": null,
    "type": "cluster_create",
    "type_label": "New cluster"
  },
  "order": null,
  "retrying": null,
  "sites": [],
  "stages": [
    {
      "at": "2026-11-14T10:00:00+00:00",
      "detail": null,
      "key": "requested",
      "label": "Requested",
      "state": "done"
    },
    {
      "at": null,
      "detail": null,
      "key": "gateway_ready",
      "label": "SSH gateway ready",
      "state": "current"
    },
    {
      "at": null,
      "detail": null,
      "key": "sites_scheduled",
      "label": "Sites scheduled",
      "state": "skipped"
    },
    {
      "at": null,
      "detail": null,
      "key": "images_pulled",
      "label": "Images pulled",
      "state": "skipped"
    },
    {
      "at": null,
      "detail": null,
      "key": "installing",
      "label": "Installing",
      "state": "skipped"
    },
    {
      "at": null,
      "detail": null,
      "key": "ready",
      "label": "Ready",
      "state": "todo"
    }
  ]
}
```

### 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, the CoreCluster was not created through a create the Control Panel recorded, or creating CoreClusters 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
}
```

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

## The same task elsewhere

- Guide: [Create a cluster](https://docs.corefinity.com/guides/corecluster/create-a-cluster.md)
- MCP tool: [`corecluster_progress_get`](https://docs.corefinity.com/mcp/tools/corecluster_progress_get.md)
