---
title: "Update a CoreCluster's package"
url: https://docs.corefinity.com/api/reference/sites/update-cluster-package
type: endpoint
last_updated: 2026-11-13
feature: upgrades
related:
  - https://docs.corefinity.com/guides/sites/size-and-capacity/upgrade-a-package.md
  - https://docs.corefinity.com/mcp/tools/corecluster_package_change.md
---
# Update a CoreCluster's package

Moves a CoreCluster to a larger package, billed at the new price once the change has finished; a smaller
package is arranged with support. `quote` is the price the change was made at, or null for a CoreCluster with
no billing contract.

```http
POST /api/corestack/clusters/{cluster}/package
```

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 5 a minute
- Long-running: answers with an operation to poll
- Try it in the console: off. It can add to your bill. Copy the request and run it yourself when you are sure.

## Path parameters

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

## Body

- `confirm_name` (string, required): The CoreCluster's name, typed exactly.
- `package` (string, required): The CoreCluster package to move to, by its key, such as `cc12`.
- `quote_id` (string or null): The `id` of a quote from `POST /corestack/billing/quote`. With it, the change is refused `409 stale` when the price is no longer the quote's.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/clusters/1017/package \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm_name": "Northwind UK 1",
    "package": "cc12"
  }'
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/clusters/1017/package', [
        'confirm_name' => 'Northwind UK 1',
        'package' => 'cc12',
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/package', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    confirm_name: 'Northwind UK 1',
    package: 'cc12',
  }),
});

// 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.post(
    "https://manage.corefinity.com/api/corestack/clusters/1017/package",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "confirm_name": "Northwind UK 1",
        "package": "cc12",
    },
)

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

## Responses

### 201 The change has started.

```json
{
  "cluster": {
    "actions": {
      "create_environment": {
        "available": true,
        "reason": null
      },
      "create_site": {
        "available": true,
        "reason": null
      },
      "delete": {
        "available": false,
        "reason": "This cluster is managed by Corefinity and cannot be deleted here"
      },
      "upgrade_package": {
        "available": true,
        "downgrade": false,
        "reason": null
      }
    },
    "allowance": {
      "cpu_millicores": 12000,
      "disk_bytes": 644245094400,
      "memory_bytes": 51539607552
    },
    "capacity": {
      "basis": "estimate",
      "cpu": {
        "capacity_millicores": 12000,
        "level": "ok",
        "percent": 1,
        "used_p95_millicores": 150
      },
      "evaluated_at": "2026-11-03T09:00:00Z",
      "level": "ok",
      "memory": {
        "capacity_bytes": 51539607552,
        "level": "ok",
        "percent": 1,
        "used_p95_bytes": 805306368
      },
      "package": {
        "cores": 12,
        "key": "cc12",
        "memory_bytes": 51539607552,
        "name": "CC12"
      },
      "sites": {
        "count": 1,
        "environments": 0
      },
      "storage": {
        "capacity_bytes": 644245094400,
        "level": "ok",
        "percent": 1,
        "provisioned_bytes": 10737418240
      }
    },
    "created_at": "2026-11-03T09:00:00Z",
    "created_by": null,
    "environments": 0,
    "id": 1017,
    "kind": "customer",
    "label": "Northwind UK 1",
    "location": {
      "label": "London (europe-west2)"
    },
    "logs": null,
    "name": "Northwind UK 1",
    "operation": null,
    "package": {
      "cores": 12,
      "key": "cc12",
      "name": "CC12"
    },
    "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": 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": 0,
      "live": 1,
      "preview": 0,
      "total": 1,
      "unknown": 1
    },
    "slug": "wordpress-cluster-1",
    "snapshots": {
      "frequency": "6h",
      "over_quota": false,
      "pruned_recently": false,
      "quota_bytes": 1288490188800,
      "retention_days": 30,
      "usage_bytes": null
    },
    "ssh_host": "ssh-northwind.example.net",
    "state": "ready",
    "state_label": "Ready",
    "state_reason": null,
    "synced": {
      "inventory_at": null,
      "live_at": null,
      "usage_at": null
    },
    "usage": {
      "cpu_millicores": null,
      "disk_used_bytes": null,
      "memory_bytes": null,
      "observed_at": null,
      "source": null
    }
  },
  "operation": {
    "applied_at": "2026-11-03T09:00:00Z",
    "can_retry": false,
    "cluster": {
      "id": 1017,
      "name": "Northwind UK 1"
    },
    "committed_at": null,
    "completed_at": "2026-11-03T09:00:00Z",
    "created_at": "2026-11-03T09:00:00Z",
    "environment": null,
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5122,
    "install": null,
    "label": null,
    "notes": [],
    "parent_operation_id": null,
    "requested_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "reset_target": null,
    "result": null,
    "result_state": "none",
    "retried_by_operation_id": null,
    "retries_operation_id": null,
    "retry_requires": null,
    "revealed": null,
    "scope": "cluster",
    "site": null,
    "status": "completed",
    "status_label": "Done",
    "step": null,
    "steps": [
      {
        "key": "checked",
        "label": "Checked",
        "state": "done"
      },
      {
        "key": "applied",
        "label": "Applied",
        "state": "done"
      }
    ],
    "subject": null,
    "summary": "CC8 → CC12",
    "to_version": null,
    "type": "package_change",
    "type_label": "Change package"
  },
  "quote": {
    "applies": "now",
    "currency": "GBP",
    "effective_from": "2026-11-03T09:00:00Z",
    "expires_at": "2026-11-03T09:15:00Z",
    "id": "e1393f30-606e-453b-a7de-b0e9e1fe6985",
    "lines": [
      {
        "after": {
          "amount": "900.00",
          "currency": "GBP"
        },
        "before": {
          "amount": "600.00",
          "currency": "GBP"
        },
        "delta": {
          "amount": "300.00",
          "currency": "GBP"
        },
        "key": "package",
        "label": "Package: CC8 → CC12"
      }
    ],
    "monthly_after": {
      "amount": "900.00",
      "currency": "GBP"
    },
    "monthly_before": {
      "amount": "600.00",
      "currency": "GBP"
    },
    "monthly_delta": {
      "amount": "300.00",
      "currency": "GBP"
    },
    "prorata": {
      "amount": {
        "amount": "277.02",
        "currency": "GBP"
      },
      "from": "2026-11-03T09:00:00Z",
      "hours": 687,
      "to": "2026-12-01T00:00:00Z"
    },
    "tax": {
      "amount": {
        "amount": "60.00",
        "currency": "GBP"
      },
      "kind": "standard",
      "note": "UK VAT 20 %",
      "rate_percent": 20
    },
    "trial": null
  },
  "shape_change": false,
  "warnings": []
}
```

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

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

### 403 The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you have not set it up (`two_factor_required`), or you may not pay for a change (`billing_forbidden`: paying is for the company's owner and billing contacts).

```json
{
  "code": "billing_forbidden",
  "message": "Billing is available to your company's owner and billing contacts.",
  "reason": "billing_forbidden"
}
```

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

### 409 Nothing was changed. `same_package`: the CoreCluster is on that package. `downgrade`: the package is smaller. `stale`: the price has moved since the quote. `cluster_busy`: another change to the CoreCluster or to one of its sites is running. `cluster_not_ready`, `cluster_deleting`, `cluster_migrating`: the CoreCluster is being created or deleted, or is still moving to its last package. `compute_blocked`: there is no room for the larger package at the moment. `support_only`, `legacy_cluster`, `cluster_on_compute`, `pool_generation_exhausted`: this CoreCluster's package is changed with support. `demo_keep_required`: the CoreCluster is a demo that has not been kept (the answer adds `keep_url` and `change`). A region with no room for the package refuses with its own reason and sentence.

```json
{
  "code": "same_package",
  "message": "This is already the package",
  "reason": "same_package"
}
```

### 422 `confirm_mismatch`: `confirm_name` is not the CoreCluster's name. `invalid`: a field is missing or wrong (`field` names it): on `package`, a package that does not exist or one the region or the CoreCluster's sites cannot take; a field that is not one of the three is refused too, naming it. `package_unknown`: the package is not a CoreCluster package, such as `cs8` (a CoreCluster with no billing contract is told so as `invalid` on `package`). `pool_above_ceiling`: the CoreCluster runs more servers than the package allows.

```json
{
  "code": "confirm_mismatch",
  "errors": {
    "confirm_name": [
      "Type the cluster's name to confirm"
    ]
  },
  "field": "confirm_name",
  "message": "Type the cluster's name to confirm",
  "reason": "confirm_mismatch"
}
```

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

### 502 The platform could not be written to, so nothing was changed. Try again in a minute.

```json
{
  "message": "The platform could not be reached. Try again in a minute."
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `billing_forbidden` | Billing is for the organisation's owner and billing contacts. Ask one of them to do this. |
| 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. |
| 409 | `same_package` | This is already the package. Choose a different one. |
| 422 | `confirm_mismatch` | Send the confirmation exactly as the field named in `field` asks for it. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 422 | `package_unknown` | That is not a package Corefinity sells for this. Choose one from the catalogue. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 502 |  | Read the message; it says what happened. |

## The same task elsewhere

- Guide: [Upgrade package](https://docs.corefinity.com/guides/sites/size-and-capacity/upgrade-a-package.md)
- MCP tool: [`corecluster_package_change`](https://docs.corefinity.com/mcp/tools/corecluster_package_change.md)
