CorefinityCorefinityDocs
Open the Control PanelControl Panel
Packages and capacity · 9 of 12

Update a site's add-ons

Sets the site's four add-on allowances (extra cores, memory, disk and log storage) to the totals sent, so 0 removes an add-on; the site is billed for them from the hour the change starts. The ceilings and steps are in the site's upgrade options (addons.max, addons.unit), and a change of log storage alone applies at once.

PUT/api/corestack/sites/{site}/addons

Path parameters

siteintegerRequired

The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.

Body

applystring

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. Defaults to now.

nowtonightwindow
coresintegerRequired

Extra cores, in all. 0 to 512.

disk_gbintegerRequired

Extra disk in GB, in all. 0 to 102400.

log_storage_gbintegerRequired

Extra log storage in GB, in all. 0 to 65536.

memory_gbintegerRequired

Extra memory in GB, in all. 0 to 4096.

quote_idstring 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. Format: uuid.

Returns

201 The change has started, or is queued, in which case queued is true.

Fields of the 201 answer
itemobject or any or nullRequired

The pending change, when it is queued.

operationobject or any or nullRequired

The change, when it started now. null when it is queued.

pendingobjectRequired

The site's waiting changes.

Fields
batchobject or nullRequired

The set of changes that will apply together. Null when nothing is waiting.

Fields
idinteger

At least 1.

statusstring
window_datestring

Format: date.

can_apply_nowobjectRequired

Whether the changes can be applied now. reason says why not, such as nothing_pending or batch_window.

Fields
availablebooleanRequired
reasonstring or nullRequired
environmentobjectRequired
Fields
idintegerRequired

The site row id. At least 1.

namestringRequired
rolestringRequired
slugstringRequired
itemsarray of objectsRequired
Fields of each item
applied_atstring or nullRequired

Format: date-time.

customer_changeobject or nullRequired

What was asked, by whom and when, and whether you can withdraw it. Null for the platform's own changes.

Fields
can_cancelboolean
requested_atstring or null

Format: date-time.

requested_byobject or any or null
summarystring
typestring
errorstring or nullRequired
idintegerRequired

The {item} to withdraw the change with. At least 1.

kindstringRequired

A change somebody asked for is customer_change. Other kinds are the platform's own.

labelstringRequired
positionintegerRequired
source_operationany or null

Always null.

statusstringRequired
noticeboolean

Whether you are told before the window. Sent only while maintenance windows are on for your company.

platform_maintenancearray of objects

Platform maintenance announced for the site. Sent only while maintenance windows are on for your company.

Fields of each item
ends_atstring

Format: date-time.

labelstring
starts_atstring

Format: date-time.

summarystring
siteobjectRequired

A site by its id and domain.

Fields
domainstringRequired
idintegerRequired
windowobjectRequired
Fields
datestringRequired

Format: date.

ends_atstringRequired

Format: date-time.

labelstringRequired
policystring or null

Sent only while maintenance windows are on for your company.

sourcestring or null

Where the window comes from. Sent only while maintenance windows are on for your company.

starts_atstringRequired

Format: date-time.

queuedbooleanRequired

Whether the change waits for the night or a window.

quoteobject or any or nullRequired

The price the change was made at. null when the site has no billing contract.

siteobjectRequired

One site or environment in full. The summaries (domains_summary, access_summary and the others) are short forms of what the endpoints of each feature answer in full. A site or environment row as lists and progress answers show it. Other fields may be present; the ones named here are always sent.

Fields
compute_familystring or null
domainstringRequired
environmentobject or any or null
healthstringRequired
healthydegradeddownapplyingunknownnot_live
hostingobject or null
Fields
cluster_kindstring

customer for a site in one of your CoreClusters, platform for a standalone CoreStack site.

labelstring
idintegerRequired

The site row id, the {site} of every /corestack/sites/{site} endpoint.

kindstringRequired

On a read (a site, the list of sites, a CoreCluster's sites, the overview): corecluster for a site in one of your CoreClusters, corestack for a standalone CoreStack site. The answer to a change that carries the row, such as creating a site, can send corestack for either; hosting.cluster_kind tells the two apart on every answer.

coreclustercorestack
limitsobjectRequired
Fields
cpu_millicoresinteger or null
disk_bytesinteger or null
memory_bytesinteger or null
logsobject or null
mariadbobjectRequired
Fields
versionstring or null
modestringRequired

production once a domain is attached, staging before.

productionstagingunknown
mode_labelstringRequired
operationobject or any or nullRequired

The change running on the row now, or null.

packageobject or null

The package of a standalone CoreStack site, with its key, code and name. Null for a CoreCluster site.

pending_changesobject

The changes waiting for the row's next maintenance window.

Fields
countinteger
window_starts_atstring or null
phpobjectRequired
Fields
versionstring or null
platformobject
Fields
keystringRequired
labelstringRequired
platform_urlstring or null

The row's own address on the platform.

primary_urlstring or nullRequired
removedbooleanRequired
restoreobject or null

The restore running on the row now, or null.

siteobject or any or null

The site the row belongs to. For a production row, the row itself.

site_idstring

The row's platform identifier.

snapshotsobject

A summary of the row's snapshots.

Fields
countinteger
effective_frequencystring
effective_labelstring
latest_ready_atstring or null
next_scheduled_atstring or null
overriddenboolean
stored_gbnumber
tierstring or nullRequired

The size of the row, such as S, M or L.

uat_sizestring or null

The size of a staging environment. Null for a production row.

usageobjectRequired
Fields
cpu_millicoresnumber or null
disk_used_bytesnumber or null
memory_bytesnumber or null
observed_atstring or null
sourcestring or null
access_summaryobject or null
actionsobject or null

What you can do with the row now. Each entry says whether it is available and, when not, why.

adoptionstring or null
cloudflareobject or null
clusterobject

A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.

Fields
idintegerRequired
namestringRequired
commandsarray of objects
countsobject

How many scheduled tasks and redirects the row has, each while its feature is on.

crons_enabledboolean or null
databaseobject or null

How to connect to the database. The password is never in this answer.

deletedobject or null

When the site was deleted and until when it can be restored. Null for a site that is not deleted.

deploy_modestring or null
deploy_mode_labelstring or null
deployments_summaryobject or null
domains_summaryobject or null
email_summaryobject or null
environmentsarray of objects
Fields of each item
env_idstringRequired

The environment's platform identifier.

hostnamestringRequired

The environment's own address on the platform.

idintegerRequired

The site row id, the {site} every /corestack/sites/{site} endpoint takes.

namestringRequired
rolestringRequired

The environment's role, such as production or staging.

role_labelstringRequired
slugstringRequired
http_auth_summaryobject or null
lifecyclestring

Where the row is in its life, such as active or deleted.

liveobject or null

The status last read from the cluster. Null until one has been read.

maintenanceobject or null
operationsarray of objects

The row's most recent operations.

Fields of each item
applied_atstring or null
can_retryboolean or null
clusterobject or any or null

The cluster the operation runs on.

committed_atstring or null
completed_atstring or nullRequired
created_atstring or nullRequired
environmentobject or any or null
errorstring or nullRequired

Why the operation failed, in plain words. Null unless status is failed.

failure_reasonstring or null

A stable code for the failure.

from_versionstring or null
hotboolean or null

True when the change applies without a maintenance window.

idintegerRequired
installobject or null
labelstring or null
notesarray of objects

What the operation did differently on purpose. Empty when nothing.

Fields of each item
codestringRequired
textstringRequired
parent_operation_idinteger or null
requested_byany

Who asked for the change.

reset_targetany

Present on some site creations and copies.

resultany

Always null here. A one-time result is read once with the reveal endpoint.

result_statestring
nonependingavailableviewed
retried_by_operation_idinteger or null
retries_operation_idinteger or null
retry_requiresany

What a retry needs first, if anything.

revealedany

Who revealed a one-time result and when, when there was one.

scopestringRequired
siteclusterbatch
siteobject or any or null

The website the operation belongs to. Null for a cluster's own operation.

statusstringRequired

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_outexecutingcompletedfailed
status_labelstringRequired
stepstring or null

The key of the step the operation is at. Null once it has completed.

stepsarray of objectsRequired
Fields of each item
keystring
labelstring
statestring

One of done, current, todo, failed or skipped.

subjectobject or null
summarystring or null
to_versionstring or null
typestringRequired

The kind of change, such as crons_change or redirects_change.

type_labelstringRequired
previewobject or null

The row's platform address, and whether HTTP authentication protects it.

production_hostsarray of strings
provisioningobject or null
runtimeobject

The PHP, MariaDB and Node.js versions with the versions the row can change to.

settingsobject or null

The environment's own switches, as PATCH /corestack/sites/{site}/environment sets them.

Fields
auto_deployboolean

Whether the environment deploys automatically from Git.

http_auth_enabledboolean

Whether HTTP authentication is on for the whole environment.

scheduled_snapshotsboolean

Whether scheduled snapshots are on.

sshobject or null

How to connect over SSH and SFTP.

windowobject or any or null

For a queued change while maintenance windows are on, the window it waits for.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403billing_forbiddenBilling is for the organisation's owner and billing contacts. Ask one of them to do this.
403company_unavailableYour company is unavailable.
403forbiddenThe person is not allowed to do this.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
409same_addonsThese are already the add-ons. Change a quantity first.
422addon_boundsAn add-on quantity is outside what is allowed. Choose a whole number inside the range the message gives.
422invalidFix the field named in field; errors says why.
422feature_offThis feature is not on for your organisation yet.
429rate_limitedWait for the seconds in Retry-After.
502noneRead the message; it says what happened.
502upstream_unavailableA service the action depends on did not answer. Try again later.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X PUT https://manage.corefinity.com/api/corestack/sites/1042/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": 0
  }'
{
  "item": null,
  "operation": {
    "applied_at": null,
    "can_retry": false,
    "cluster": {
      "id": 1017,
      "name": "CoreStack"
    },
    "committed_at": "2026-11-03T09:00:00+00:00",
    "completed_at": null,
    "created_at": "2026-11-03T09:00:00+00:00",
    "environment": {
      "env_id": "rs-northwind-harbourandfinch-example-com",
      "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
      "id": 1042,
      "name": "Production",
      "role": "production",
      "role_label": "Production",
      "slug": "production"
    },
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5121,
    "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": "site",
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "status": "committed",
    "status_label": "In progress",
    "steps": [
      {
        "key": "quoted",
        "label": "Quoted",
        "state": "done"
      },
      {
        "key": "committed",
        "label": "Committed",
        "state": "done"
      },
      {
        "key": "applied",
        "label": "Applied",
        "state": "current"
      },
      {
        "key": "contract_changed",
        "label": "Contract updated",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "Change add-ons",
    "to_version": null,
    "type": "addon_change",
    "type_label": "Change add-ons"
  },
  "pending": {
    "batch": null,
    "can_apply_now": {
      "available": false,
      "reason": "nothing_pending"
    },
    "environment": {
      "id": 1042,
      "name": "Production",
      "role": "production",
      "slug": "production"
    },
    "items": [],
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "tier": null,
    "window": {
      "date": "2026-11-03",
      "ends_at": "2026-11-04T07:00:00Z",
      "label": "Tonight 21:00–07:00 (Europe/London)",
      "starts_at": "2026-11-03T21:00:00Z"
    }
  },
  "queued": false,
  "quote": {
    "applies": "now",
    "currency": "GBP",
    "effective_from": "2026-11-03T09:00:00Z",
    "expires_at": "2026-11-03T09:15:00Z",
    "id": "5e68f8fe-7f67-4cf9-8253-ac2f9582cf88",
    "lines": [
      {
        "after": {
          "amount": "90.00",
          "currency": "GBP"
        },
        "before": null,
        "delta": {
          "amount": "90.00",
          "currency": "GBP"
        },
        "key": "addon_cores",
        "label": "Add-on: 2 cores"
      }
    ],
    "monthly_after": {
      "amount": "90.00",
      "currency": "GBP"
    },
    "monthly_before": {
      "amount": "0.00",
      "currency": "GBP"
    },
    "monthly_delta": {
      "amount": "90.00",
      "currency": "GBP"
    },
    "prorata": {
      "amount": {
        "amount": "83.10",
        "currency": "GBP"
      },
      "from": "2026-11-03T09:00:00Z",
      "hours": 687,
      "to": "2026-12-01T00:00:00Z"
    },
    "tax": {
      "amount": {
        "amount": "18.00",
        "currency": "GBP"
      },
      "kind": "standard",
      "note": "UK VAT 20 %",
      "rate_percent": 20
    },
    "trial": null
  },
  "site": {
    "access_summary": {
      "apply_state": "never",
      "company_keys": 0,
      "keys": 0,
      "users": 0
    },
    "actions": {
      "apply_pending_now": {
        "available": false,
        "reason": "Nothing is waiting for tonight."
      },
      "attach_domain": {
        "available": false,
        "reason": "This environment already has a domain attached"
      },
      "change_url": {
        "available": false,
        "reason": "Domains are switched off at the moment"
      },
      "clone": {
        "available": false,
        "reason": "Copying data into an environment is switched off at the moment"
      },
      "create_environment": {
        "available": true,
        "reason": null
      },
      "delete": {
        "available": false,
        "reason": "Another change to this site is in progress. Wait for it to finish."
      },
      "go_live": {
        "available": false,
        "reason": "This environment already has a domain attached"
      },
      "maintenance": {
        "available": true,
        "reason": null
      },
      "push_to_live": {
        "available": false,
        "reason": "This is production"
      },
      "restore_deleted": {
        "available": false,
        "reason": "This site is not deleted"
      },
      "terminal": {
        "available": false,
        "reason": "The terminal is available once the site is running"
      }
    },
    "adoption": "adopted",
    "billing": {
      "account_id": 9102
    },
    "cloudflare": {
      "connected": false,
      "zone": null
    },
    "cluster": {
      "id": 1017,
      "name": "CoreStack"
    },
    "commands": [],
    "compute_family": "general",
    "counts": {
      "crons": 1
    },
    "crons_enabled": true,
    "database": {
      "host": "127.0.0.1",
      "name": "wordpress",
      "password_revealable": true,
      "port": 3306,
      "username": "application",
      "via": "SSH tunnel"
    },
    "deleted": null,
    "deploy_mode": "manual",
    "deploy_mode_label": "Manual",
    "deployments_summary": {
      "last": null,
      "mode": "manual"
    },
    "domain": "harbourandfinch.example.com",
    "domains_summary": {
      "aliases": 1,
      "dns": "unknown",
      "noindex": false,
      "primary": "harbourandfinch.example.com",
      "tls": "none",
      "www": null
    },
    "email_summary": {
      "sending_domain": null,
      "state": "not_set_up"
    },
    "environment": {
      "env_id": "rs-northwind-harbourandfinch-example-com",
      "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
      "id": 1042,
      "name": "Production",
      "role": "production",
      "role_label": "Production",
      "slug": "production"
    },
    "environments": [
      {
        "env_id": "rs-northwind-harbourandfinch-example-com",
        "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
        "id": 1042,
        "name": "Production",
        "role": "production",
        "role_label": "Production",
        "slug": "production"
      }
    ],
    "health": "applying",
    "hosting": {
      "cluster_kind": "platform",
      "label": "CoreStack"
    },
    "http_auth_summary": {
      "apply_state": "applied",
      "enabled": false,
      "rules": 0,
      "users": 0
    },
    "id": 1042,
    "kind": "corestack",
    "lifecycle": "active",
    "limits": {
      "cpu_millicores": 2000,
      "disk_bytes": 10737418240,
      "memory_bytes": 4294967296
    },
    "live": null,
    "logs": null,
    "maintenance": {
      "bypass_corefinity": 1,
      "bypass_ips": [],
      "enabled": false,
      "since": null
    },
    "mariadb": {
      "version": "11.4"
    },
    "mode": "production",
    "mode_label": "Domain attached",
    "operation": {
      "id": 5121,
      "scope": "site",
      "status": "committed",
      "status_label": "Waiting for the platform",
      "summary": "Add-ons: 2 cores, 0 GB RAM, 0 GB disk, 0 GB log storage",
      "to_version": null,
      "type": "addon_change",
      "type_label": "Change add-ons"
    },
    "operations": [
      {
        "applied_at": null,
        "can_retry": false,
        "cluster": {
          "id": 1017,
          "name": "CoreStack"
        },
        "committed_at": "2026-11-03T09:00:00Z",
        "completed_at": null,
        "created_at": "2026-11-03T09:00:00Z",
        "environment": {
          "env_id": "rs-northwind-harbourandfinch-example-com",
          "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
          "id": 1042,
          "name": "Production",
          "role": "production",
          "role_label": "Production",
          "slug": "production"
        },
        "error": null,
        "failure_reason": null,
        "from_version": null,
        "hot": false,
        "id": 5121,
        "install": null,
        "label": "Applied",
        "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": "site",
        "site": {
          "domain": "harbourandfinch.example.com",
          "id": 1042
        },
        "status": "committed",
        "status_label": "Waiting for the platform",
        "step": "applied",
        "steps": [
          {
            "key": "quoted",
            "label": "Quoted",
            "state": "done"
          },
          {
            "key": "committed",
            "label": "Committed",
            "state": "done"
          },
          {
            "key": "applied",
            "label": "Applied",
            "state": "current"
          },
          {
            "key": "contract_changed",
            "label": "Contract updated",
            "state": "todo"
          }
        ],
        "subject": null,
        "summary": "Add-ons: 2 cores, 0 GB RAM, 0 GB disk, 0 GB log storage",
        "to_version": null,
        "type": "addon_change",
        "type_label": "Change add-ons"
      }
    ],
    "package": {
      "code": "CS4",
      "key": "cs4",
      "name": "CS4"
    },
    "pending_changes": {
      "count": 0,
      "outcome_at": null,
      "state": null,
      "window_starts_at": null
    },
    "php": {
      "version": "8.3"
    },
    "platform": {
      "key": "wordpress",
      "label": "WordPress"
    },
    "platform_plugins": {
      "anchor": "#platform-plugins",
      "enabled": true,
      "layout": "classic",
      "reason": null
    },
    "platform_url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
    "preview": {
      "label": "Platform address",
      "protected": false,
      "url": "https://harbourandfinch-example-com.northwind.cfstack.example.net"
    },
    "primary_url": "https://harbourandfinch.example.com",
    "production_hosts": [
      "harbourandfinch.example.com",
      "www.harbourandfinch.example.com"
    ],
    "provisioning": null,
    "removed": false,
    "restore": null,
    "runtime": {
      "container_memory_limits": {
        "cli": 268435456,
        "mariadb": 1073741824,
        "nginx": 134217728,
        "php": 2617245696,
        "redis": 134217728
      },
      "mariadb": {
        "options": [
          {
            "allowed": false,
            "current": true,
            "label": "MariaDB 11.4",
            "reason": "This is the current version",
            "version": "11.4"
          },
          {
            "allowed": false,
            "current": false,
            "label": "MariaDB 11.8",
            "reason": "Live status is unavailable. Try again in a minute.",
            "version": "11.8"
          },
          {
            "allowed": false,
            "current": false,
            "label": "MariaDB 12.3",
            "reason": "Upgrade one LTS release at a time",
            "version": "12.3"
          }
        ],
        "upgrade_only": true,
        "version": "11.4"
      },
      "node": {
        "major": null,
        "status": null
      },
      "php": {
        "eol_date": "2027-12-31",
        "options": [
          {
            "ack_detail": [],
            "allowed": false,
            "changes": [],
            "current": false,
            "eol_date": "2026-12-31",
            "label": "PHP 8.2",
            "reason": "Another change is in progress",
            "requires_ack": [],
            "status": "security",
            "version": "8.2"
          },
          {
            "ack_detail": [],
            "allowed": false,
            "changes": [],
            "current": true,
            "eol_date": "2027-12-31",
            "label": "PHP 8.3",
            "reason": "This is the current version",
            "requires_ack": [],
            "status": "supported",
            "version": "8.3"
          },
          {
            "ack_detail": [],
            "allowed": false,
            "changes": [],
            "current": false,
            "eol_date": "2028-12-31",
            "label": "PHP 8.4",
            "reason": "Another change is in progress",
            "requires_ack": [],
            "status": "supported",
            "version": "8.4"
          },
          {
            "ack_detail": [],
            "allowed": false,
            "changes": [],
            "current": false,
            "eol_date": "2029-12-31",
            "label": "PHP 8.5",
            "reason": "Another change is in progress",
            "requires_ack": [],
            "status": "supported",
            "version": "8.5"
          }
        ],
        "status": "supported",
        "version": "8.3"
      },
      "requests": {
        "cpu_millicores": 100,
        "memory_bytes": 536870912
      }
    },
    "settings": {
      "auto_deploy": false,
      "http_auth_enabled": false,
      "scheduled_snapshots": true
    },
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "site_id": "rs-northwind-harbourandfinch-example-com",
    "snapshots": {
      "count": 0,
      "effective_frequency": "6h",
      "effective_label": "Every 6 hours",
      "latest": null,
      "latest_ready_at": null,
      "next_scheduled_at": "2026-11-03T12:11:00Z",
      "overridden": false,
      "stored_gb": 0
    },
    "ssh": {
      "command": "ssh -p 20001 [email protected]",
      "host": "ssh-northwind.example.net",
      "key_management": false,
      "keys": [],
      "port": 20001,
      "sftp_command": "sftp -P 20001 [email protected]",
      "tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20001 [email protected]",
      "user": "web",
      "users": 0
    },
    "tier": "cs4",
    "uat_size": null,
    "usage": {
      "cpu_millicores": null,
      "disk_used_bytes": null,
      "memory_bytes": null,
      "observed_at": null,
      "source": null
    }
  }
}
Try it

Try it is off for this endpointIt can add to your bill. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT