---
title: "Switch a CoreCluster's server type"
url: https://docs.corefinity.com/api/reference/sites/switch-cluster-compute-family
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_compute_family_switch.md
---
# Switch a CoreCluster's server type

Moves every site of a CoreCluster between the two server types, `general` (Standard) and `optimised`
(Performance); the CoreCluster is billed at the new price once the last site has moved. It is all or nothing:
when any site cannot move yet, nothing is queued and the refusal's `refused` lists each such site. A
CoreCluster with no billing contract takes the change all the same, unpriced: `quote` is null.

```http
POST /api/corestack/clusters/{cluster}/compute-family
```

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 10 a minute
- 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

- `apply` (string): When a change that needs a maintenance window is applied. `now` applies it at once. `tonight` queues it for the site's next window. `window` means the same as `tonight`. An endpoint that takes `window` only while maintenance windows are on for your company says so, and refuses it `422` on `apply` otherwise. One of `now`, `tonight`, `window`. Defaults to `now`.
- `confirm_name` (string, required): The CoreCluster's name, typed exactly.
- `family` (string, required): The server type to move to. `general` is Standard and `optimised` is Performance. One of `general`, `optimised`.
- `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/compute-family \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm_name": "Northwind UK 1",
    "family": "optimised"
  }'
```

### PHP

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

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

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

### Node

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

// 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/compute-family",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "confirm_name": "Northwind UK 1",
        "family": "optimised",
    },
)

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

## Responses

### 201 The moves are queued or started: one entry of `items` for each site, with its own operation once it has started. `settled` is `true` when no site had to move.

```json
{
  "already": [],
  "cluster": {},
  "items": [],
  "operation": null,
  "pending": null,
  "queued": false,
  "quote": null,
  "settled": true
}
```

### 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_family`: the CoreCluster is on that server type. `stale`: the price has moved since the quote. `no_payment_method`: the billing account has no card or mandate. `family_change_pending`: an earlier change of server type has not finished. `compute_capacity_blocked`: the servers of that type have no room at the moment. `demo_keep_required`: the CoreCluster is a demo that has not been kept (the answer adds `keep_url` and `change`). When a site cannot move yet, the answer is that site's own refusal, its domain before the sentence, with `refused` listing every such site.

```json
{
  "code": "same_family",
  "message": "This is already the server type",
  "reason": "same_family"
}
```

### 422 `confirm_mismatch`: `confirm_name` is not the CoreCluster's name. `invalid`: a field is missing or wrong (`field` names it). `family_unavailable`: the server type is not offered in the region.

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

### 503 The region the site or CoreCluster runs in cannot take the move at the moment: it is not ready (`temporarily_unavailable`), or it has no servers of the other type yet (`tier_cluster_missing`). Nothing was changed. Try again later, or open a ticket. For a CoreCluster the sentence starts with the site's domain and `refused` lists each site that cannot move.

```json
{
  "code": "temporarily_unavailable",
  "message": "This region is not ready",
  "reason": "temporarily_unavailable"
}
```

## 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_family` | This is already the server type. 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. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 503 | `temporarily_unavailable` | The Control Panel could not answer just now. Nothing was started; try again shortly. |
| 503 | `tier_cluster_missing` | The platform has no compute cluster for this here yet. Contact support. |

## The same task elsewhere

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