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.
Path parameters
The id of a CoreCluster. Digits only. At least 1.
Body
Extra cores, in all. 0 to 512.
Extra disk in GB, in all. 0 to 102400.
Extra log storage in GB, in all. 0 to 65536.
Extra memory in GB, in all. 0 to 4096.
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. Format: uuid.
Returns
200 The add-ons were applied. operation is the change, already completed.
Fields of the 200 answer
A CoreCluster. Every answer that carries a CoreCluster carries this object. Other fields may be present; the ones named in required are always sent.
Fields
What can be done with the CoreCluster now.
Fields
Whether something can be done now and, when it cannot, why not.
Fields
May add grows, true when the CoreCluster is full and would grow first under automatic upgrades.
Fields
Whether something can be done now and, when it cannot, why not.
Fields
Adds downgrade, true when a smaller package can be chosen.
Fields
What the package allows.
Fields
Sent only by GET /corestack/clusters/{cluster}, while billing is on for your company.
Fields
The billing account the CoreCluster is charged to. Null when nothing charges it yet, or you cannot see the account. At least 1.
How much of the package the CoreCluster's sites use.
Fields
What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).
p95mixedestimateOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedFormat: date-time.
The worst level of the meters.
okwarningblockedOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedThe package the figures are measured against. Null for a CoreCluster with no package.
Fields
Fields
One meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedFormat: date-time.
How many environments besides production the CoreCluster has.
The {cluster} of every /corestack/clusters/{cluster} endpoint. At least 1.
customer for a CoreCluster of your own.
customerplatformFields
arm64amd64Where the CoreCluster runs.
How much log storage the CoreCluster uses. Null when its logs are not collected.
The change running on the CoreCluster now, or the one that left it failed. Null otherwise.
The CoreCluster's package. Null when it has none, and while packages are off for your company.
Fields
The changes waiting for the next maintenance window of the CoreCluster's sites.
Fields
Format: date-time.
Format: date-time.
Fields
The region key, as a create takes it.
What the sizes of the CoreCluster's sites add up to.
Fields
How many sites the CoreCluster has, and how they are doing.
Fields
Environments besides production.
Sites with a domain attached.
Sites with no domain attached yet.
Made from the name when the CoreCluster is created. It never changes.
The short form of the CoreCluster's snapshot settings and storage.
Fields
The address the CoreCluster's sites are reached on over SSH.
creatingreadydegradedmigratingdeletingfailedWhy the CoreCluster is degraded, migrating or failed, in plain words.
When the list of sites, the usage and the live status were last read.
Fields
Format: date-time.
Format: date-time.
Format: date-time.
What the sites use now. A figure is null where nothing was measured.
Fields
Format: date-time.
A change the Control Panel is making or has made. A save or an action that starts work answers one in operation; read it again by id with GET / until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.
Fields
The cluster the operation runs on.
Why the operation failed, in plain words. Null unless status is failed.
A stable code for the failure.
True when the change applies without a maintenance window.
What the operation did differently on purpose. Empty when nothing.
Fields of each item
Who asked for the change.
Present on some site creations and copies.
Always null here. A one-time result is read once with the reveal endpoint.
nonependingavailableviewedWhat a retry needs first, if anything.
Who revealed a one-time result and when, when there was one.
siteclusterbatchThe website the operation belongs to. Null for a cluster's own operation.
Where a change is. completed and failed are final; every other status means the change is still running and blocks another change to the same site.
pendingcommittedrolling_outexecutingcompletedfailedThe key of the step the operation is at. Null once it has completed.
Fields of each item
One of done, current, todo, failed or skipped.
The kind of change, such as crons_change or redirects_change.
The price the change was made at. null when the CoreCluster has no billing contract.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | 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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
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
}'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();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);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{
"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
}
}{
"message": "Unauthenticated."
}{
"code": "billing_forbidden",
"message": "Billing is available to your company's owner and billing contacts.",
"reason": "billing_forbidden"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "stale",
"message": "Prices changed. Review the quote again.",
"reason": "stale"
}{
"code": "addon_bounds",
"message": "Cores must be a whole number from 0 to 16.",
"reason": "addon_bounds"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt can add to your bill. Copy the request and run it yourself when you are sure.