---
title: "Update a CoreCluster's add-ons"
url: https://docs.corefinity.com/api/reference/sites/update-cluster-addons
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_addons_set.md
---
# Update a CoreCluster's add-ons

Sets the CoreCluster's four add-on allowances (extra cores, memory, disk and log storage) to the totals sent,
so `0` removes an add-on. The change applies at once and is billed from the next hour; the ceilings and steps
are in the CoreCluster's upgrade options (`addons.max`, `addons.unit`). A CoreCluster with no billing
contract takes the change all the same, unpriced: `quote` is null.

```http
PUT /api/corestack/clusters/{cluster}/addons
```

- 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

- `cores` (integer, required): Extra cores, in all.
- `disk_gb` (integer, required): Extra disk in GB, in all.
- `log_storage_gb` (integer, required): Extra log storage in GB, in all.
- `memory_gb` (integer, required): Extra memory in GB, in all.
- `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 PUT https://manage.corefinity.com/api/corestack/clusters/1017/addons \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "cores": 2,
    "disk_gb": 0,
    "log_storage_gb": 0,
    "memory_gb": 8
  }'
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->put('https://manage.corefinity.com/api/corestack/clusters/1017/addons', [
        'cores' => 2,
        'disk_gb' => 0,
        'log_storage_gb' => 0,
        'memory_gb' => 8,
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/addons', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    cores: 2,
    disk_gb: 0,
    log_storage_gb: 0,
    memory_gb: 8,
  }),
});

// 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.put(
    "https://manage.corefinity.com/api/corestack/clusters/1017/addons",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "cores": 2,
        "disk_gb": 0,
        "log_storage_gb": 0,
        "memory_gb": 8,
    },
)

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

## Responses

### 200 The add-ons were applied. `operation` is the change, already completed.

```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": 10000,
      "disk_bytes": 429496729600,
      "memory_bytes": 42949672960
    },
    "capacity": {
      "basis": "estimate",
      "cpu": {
        "capacity_millicores": 10000,
        "level": "ok",
        "percent": 1,
        "used_p95_millicores": 150
      },
      "evaluated_at": "2026-11-03T09:00:00Z",
      "level": "ok",
      "memory": {
        "capacity_bytes": 42949672960,
        "level": "ok",
        "percent": 1,
        "used_p95_bytes": 805306368
      },
      "package": {
        "cores": 8,
        "key": "cc8",
        "memory_bytes": 34359738368,
        "name": "CC8"
      },
      "sites": {
        "count": 1,
        "environments": 0
      },
      "storage": {
        "capacity_bytes": 429496729600,
        "level": "ok",
        "percent": 2,
        "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": 8,
      "key": "cc8",
      "name": "CC8"
    },
    "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": 858993459200,
      "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:00+00:00",
    "can_retry": false,
    "cluster": {
      "id": 1017,
      "name": "Northwind UK 1"
    },
    "committed_at": null,
    "completed_at": "2026-11-03T09:00:00+00:00",
    "created_at": "2026-11-03T09:00:00+00:00",
    "environment": null,
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5123,
    "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": "completed",
    "status_label": "Done",
    "steps": [
      {
        "key": "quoted",
        "label": "Quoted",
        "state": "done"
      },
      {
        "key": "committed",
        "label": "Committed",
        "state": "skipped"
      },
      {
        "key": "applied",
        "label": "Applied",
        "state": "done"
      },
      {
        "key": "contract_changed",
        "label": "Contract updated",
        "state": "done"
      }
    ],
    "subject": null,
    "summary": "Change add-ons",
    "to_version": null,
    "type": "addon_change",
    "type_label": "Change add-ons"
  },
  "quote": {
    "applies": "now",
    "currency": "GBP",
    "effective_from": "2026-11-03T09:00:00Z",
    "expires_at": "2026-11-03T09:15:00Z",
    "id": "728d4699-2ce9-4c2d-b455-466f42eedba6",
    "lines": [
      {
        "after": {
          "amount": "90.00",
          "currency": "GBP"
        },
        "before": null,
        "delta": {
          "amount": "90.00",
          "currency": "GBP"
        },
        "key": "addon_cores",
        "label": "Add-on: 2 cores"
      },
      {
        "after": {
          "amount": "40.00",
          "currency": "GBP"
        },
        "before": null,
        "delta": {
          "amount": "40.00",
          "currency": "GBP"
        },
        "key": "addon_memory_gb",
        "label": "Add-on: 8 GB memory"
      }
    ],
    "monthly_after": {
      "amount": "130.00",
      "currency": "GBP"
    },
    "monthly_before": {
      "amount": "0.00",
      "currency": "GBP"
    },
    "monthly_delta": {
      "amount": "130.00",
      "currency": "GBP"
    },
    "prorata": {
      "amount": {
        "amount": "120.04",
        "currency": "GBP"
      },
      "from": "2026-11-03T09:00:00Z",
      "hours": 687,
      "to": "2026-12-01T00:00:00Z"
    },
    "tax": {
      "amount": {
        "amount": "26.00",
        "currency": "GBP"
      },
      "kind": "standard",
      "note": "UK VAT 20 %",
      "rate_percent": 20
    },
    "trial": null
  }
}
```

### 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. `stale`: the price has moved since the quote. `no_payment_method`: the billing account has no card or mandate. `cluster_busy`: another change to the CoreCluster is running, or its sites are being moved. `cluster_not_ready`, `cluster_deleting`, `cluster_migrating`: the CoreCluster is being created or deleted, or is still moving to its last package. `capacity_blocked`: a smaller allowance would leave less than the CoreCluster's sites use (`dimension` names what). `compute_blocked`: there is no room for the extra cores or memory at the moment. `cluster_legacy`: capacity is added to this CoreCluster with support. `demo_keep_required`: the CoreCluster is a demo that has not been kept (the answer adds `keep_url` and `change`).

```json
{
  "code": "stale",
  "message": "Prices changed. Review the quote again.",
  "reason": "stale"
}
```

### 422 `invalid`: a field is missing or wrong (`field` names it). `addon_bounds`: an allowance is above its ceiling or off its step (an allowance the CoreCluster holds already is never refused for its size).

```json
{
  "code": "addon_bounds",
  "message": "Cores must be a whole number from 0 to 16.",
  "reason": "addon_bounds"
}
```

### 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 | `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 | `stale` | What you read has changed since you read it. Read it again, then send the change with its new version or quote. |
| 422 | `addon_bounds` | An add-on quantity is outside what is allowed. Choose a whole number inside the range the message gives. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 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_addons_set`](https://docs.corefinity.com/mcp/tools/corecluster_addons_set.md)
