---
title: "Get a CoreCluster's upgrade options"
url: https://docs.corefinity.com/api/reference/sites/get-cluster-upgrade-options
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_upgrade_options_get.md
---
# Get a CoreCluster's upgrade options

Answers what a CoreCluster can change to and what each choice costs a month: the CoreCluster packages, its
add-ons with their unit prices and ceilings, the server types, and whether you may pay for a change
(`rights.can_pay`). `uat` and `pending` are null for a CoreCluster, and one with no billing contract is
offered the same changes without prices (`not_billed`).

```http
GET /api/corestack/clusters/{cluster}/upgrade-options
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 120 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/upgrade-options \
  -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/upgrade-options');

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

### Node

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

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

## Responses

### 200 The upgrade options.

```json
{
  "addons": {
    "available": {
      "available": true,
      "reason": null
    },
    "current": {
      "cores": 0,
      "disk_gb": 0,
      "log_storage_gb": 0,
      "memory_gb": 0
    },
    "max": {
      "cores": 16,
      "disk_gb": 102400,
      "log_storage_gb": 1000,
      "memory_gb": 64
    },
    "unit": [
      {
        "key": "core",
        "label": "Extra core",
        "max": 16,
        "monthly": {
          "amount": "45.00",
          "currency": "GBP"
        },
        "step": 1,
        "unit": "core"
      },
      {
        "key": "memory_gb",
        "label": "Extra memory",
        "max": 64,
        "monthly": {
          "amount": "5.00",
          "currency": "GBP"
        },
        "step": 1,
        "unit": "GB"
      },
      {
        "key": "disk_gb",
        "label": "Extra disk",
        "max": 102400,
        "monthly": {
          "amount": "0.20",
          "currency": "GBP"
        },
        "step": 10,
        "unit": "GB"
      },
      {
        "key": "log_storage_gb",
        "label": "Extra log storage",
        "max": 1000,
        "monthly": {
          "amount": "0.10",
          "currency": "GBP"
        },
        "step": 1,
        "unit": "GB"
      }
    ]
  },
  "apply_default": "now",
  "can_apply_tonight": true,
  "contract": {
    "id": 8169,
    "reference": "MC-2-2"
  },
  "currency": "GBP",
  "family": [
    {
      "available": true,
      "current": true,
      "key": "general",
      "label": "Standard",
      "monthly_delta": {
        "amount": "0.00",
        "currency": "GBP"
      },
      "note": null,
      "provisioned": false,
      "reason": "first"
    },
    {
      "available": true,
      "current": false,
      "key": "optimised",
      "label": "Performance",
      "monthly_delta": {
        "amount": "120.00",
        "currency": "GBP"
      },
      "note": null,
      "provisioned": false,
      "reason": "first"
    }
  ],
  "not_billed": null,
  "packages": [
    {
      "available": {
        "available": false,
        "reason": "Ask us to move to a smaller package"
      },
      "change": {
        "direction": "downgrade",
        "notes": []
      },
      "code": "CC4",
      "cores": 4,
      "disk_gb": 200,
      "key": "cc4",
      "memory_gib": 16,
      "monthly": {
        "amount": "300.00",
        "currency": "GBP"
      },
      "name": "CoreCluster CC4"
    },
    {
      "available": {
        "available": false,
        "reason": "Ask us to move to a smaller package"
      },
      "change": {
        "direction": "downgrade",
        "notes": []
      },
      "code": "CC6",
      "cores": 6,
      "disk_gb": 300,
      "key": "cc6",
      "memory_gib": 24,
      "monthly": {
        "amount": "450.00",
        "currency": "GBP"
      },
      "name": "CoreCluster CC6"
    },
    {
      "available": {
        "available": true,
        "reason": null
      },
      "change": null,
      "code": "CC8",
      "cores": 8,
      "disk_gb": 400,
      "key": "cc8",
      "memory_gib": 32,
      "monthly": {
        "amount": "600.00",
        "currency": "GBP"
      },
      "name": "CoreCluster CC8"
    }
  ],
  "pending": null,
  "rights": {
    "can_edit": true,
    "can_pay": false,
    "can_view": true,
    "reason": null
  },
  "subject": {
    "family": "general",
    "monthly": {
      "amount": "600.00",
      "currency": "GBP"
    },
    "package": {
      "code": "CC8",
      "key": "cc8"
    },
    "ref": {
      "id": 1017,
      "name": "Northwind UK 1"
    },
    "region": {
      "key": "uk",
      "label": "United Kingdom"
    },
    "type": "cluster"
  },
  "uat": null
}
```

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

## 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: [Upgrade package](https://docs.corefinity.com/guides/sites/size-and-capacity/upgrade-a-package.md)
- MCP tool: [`corecluster_upgrade_options_get`](https://docs.corefinity.com/mcp/tools/corecluster_upgrade_options_get.md)
