CorefinityCorefinityDocs
Open the Control PanelControl Panel
CoreCluster · 2 of 10

Create a CoreCluster

Creates a CoreCluster in a region on a package, with up to ten first sites, charged at the package's price from the moment it is created. Follow it with GET /corestack/clusters/{cluster}/progress until it has finished. Only a create that is accepted counts towards the rate limit, which your whole company shares.

POST/api/corestack/clusters

Body

compute_familystring

The server type. optimised is accepted only while it is offered to your company. Defaults to general.

generaloptimised
namestringRequired

The CoreCluster's name: letters, digits, spaces and . & ' ( ) -, starting with a letter or a digit. No other CoreCluster of your company may have it. Up to 100 characters.

packagestringRequired

The key of a CoreCluster package, such as xsmall. GET /corestack/packages lists them.

regionstringRequired

A region that is open for the package. GET /corestack/regions lists them.

ukusnlaus
sitesarray of objects

The first sites to create with the CoreCluster. Add the rest once it is ready. Up to 10 items.

Fields of each item
contentstringRequired

empty for a site with no application installed, fresh for a fresh install.

emptyfresh
domainstringRequired

The site's public domain, without www.. Each domain may appear once in the request. Up to 253 characters.

freshobject or any or null

The settings of a fresh install. Read only when content is fresh.

mariadb_versionstring

A MariaDB version the platform offers. Left out, the platform's default.

node_acknowledgearray of strings

["eol"] to accept a Node.js version past its end of life, which is refused ack_required without it. Up to 1 items.

eol
node_majorinteger or null

The Node.js major version for the site, as a number such as 22, from the ones offered for the platform. Left out, the default. Where a new site cannot choose one yet, it is refused runtime_not_adopted. 1 to 99.

php_versionstring

A PHP version the platform offers, such as 8.3. Left out, the platform's default.

platformstringRequired

A platform the package offers, such as wordpress, laravel or magento2.

tierstringRequired

The size of the site, such as S, M or L. It must be one the platform has and the package offers.

varnishobject or null

Magento 2 only. Whether the site starts with Varnish. Left out, the platform decides.

Fields
enabledbooleanRequired
versionstring or null

A Varnish version the platform offers, such as 7.7. Only with enabled true.

Returns

201 The CoreCluster is being created. sites lists each first site with its own operation.

202 The create was accepted and its first step is still being confirmed. The body is the same as for 201, with the operation's status pending. Poll the operation until it finishes.

Fields of the 201 answer
clusterobjectRequired

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
actionsobjectRequired

What can be done with the CoreCluster now.

Fields
create_environmentobjectRequired

Whether something can be done now and, when it cannot, why not.

Fields
availablebooleanRequired
reasonstring or nullRequired
create_siteobjectRequired

May add grows, true when the CoreCluster is full and would grow first under automatic upgrades.

Fields
availablebooleanRequired
reasonstring or nullRequired
deleteobjectRequired

Whether something can be done now and, when it cannot, why not.

Fields
availablebooleanRequired
reasonstring or nullRequired
upgrade_packageobjectRequired

Adds downgrade, true when a smaller package can be chosen.

Fields
availablebooleanRequired
reasonstring or nullRequired
allowanceobjectRequired

What the package allows.

Fields
cpu_millicoresinteger or null
disk_bytesinteger or null
memory_bytesinteger or null
billingobject

Sent only by GET /corestack/clusters/{cluster}, while billing is on for your company.

Fields
account_idinteger or nullRequired

The billing account the CoreCluster is charged to. Null when nothing charges it yet, or you cannot see the account. At least 1.

capacityobjectRequired

How much of the package the CoreCluster's sites use.

Fields
basisstringRequired

What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).

p95mixedestimate
cpuobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_millicoresinteger
used_p95_millicoresnumber or null
evaluated_atstring or nullRequired

Format: date-time.

levelstringRequired

The worst level of the meters.

okwarningblocked
memoryobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
used_p95_bytesnumber or null
packageobject or nullRequired

The package the figures are measured against. Null for a CoreCluster with no package.

Fields
coresinteger
keystring
memory_bytesinteger
namestring
sitesobjectRequired
Fields
countintegerRequired
environmentsintegerRequired
storageobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
provisioned_bytesnumber or null
created_atstring or nullRequired

Format: date-time.

created_byobject or any or nullRequired
environmentsintegerRequired

How many environments besides production the CoreCluster has.

idintegerRequired

The {cluster} of every /corestack/clusters/{cluster} endpoint. At least 1.

kindstringRequired

customer for a CoreCluster of your own.

customerplatform
labelstringRequired
locationobjectRequired
Fields
archstring
arm64amd64
labelstring

Where the CoreCluster runs.

logsobject or nullRequired

How much log storage the CoreCluster uses. Null when its logs are not collected.

namestringRequired
operationobject or any or nullRequired

The change running on the CoreCluster now, or the one that left it failed. Null otherwise.

packageobject or nullRequired

The CoreCluster's package. Null when it has none, and while packages are off for your company.

Fields
coresinteger
keystring
namestring
pending_changesobjectRequired

The changes waiting for the next maintenance window of the CoreCluster's sites.

Fields
countinteger
window_starts_atstring or null

Format: date-time.

ready_atstring or nullRequired

Format: date-time.

regionobjectRequired
Fields
keystringRequired

The region key, as a create takes it.

labelstringRequired
placestringRequired
reservedobjectRequired

What the sizes of the CoreCluster's sites add up to.

Fields
cpu_limit_millicoresinteger
cpu_request_millicoresinteger
disk_bytesinteger
memory_limit_bytesinteger
memory_request_bytesinteger
sitesobjectRequired

How many sites the CoreCluster has, and how they are doing.

Fields
applyingintegerRequired
degradedintegerRequired
downintegerRequired
environmentsintegerRequired

Environments besides production.

healthyintegerRequired
liveintegerRequired

Sites with a domain attached.

previewintegerRequired

Sites with no domain attached yet.

totalintegerRequired
unknownintegerRequired
slugstringRequired

Made from the name when the CoreCluster is created. It never changes.

snapshotsobjectRequired

The short form of the CoreCluster's snapshot settings and storage.

Fields
frequencystring
over_quotaboolean
pruned_recentlyboolean
quota_bytesinteger or null
retention_daysinteger or null
usage_bytesinteger or null
ssh_hoststringRequired

The address the CoreCluster's sites are reached on over SSH.

statestringRequired
creatingreadydegradedmigratingdeletingfailed
state_labelstringRequired
state_reasonstring or nullRequired

Why the CoreCluster is degraded, migrating or failed, in plain words.

syncedobjectRequired

When the list of sites, the usage and the live status were last read.

Fields
inventory_atstring or null

Format: date-time.

live_atstring or null

Format: date-time.

usage_atstring or null

Format: date-time.

usageobjectRequired

What the sites use now. A figure is null where nothing was measured.

Fields
cpu_millicoresnumber or null
disk_used_bytesnumber or null
memory_bytesnumber or null
observed_atstring or null

Format: date-time.

sourcestring or null
operationobjectRequired

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 /corestack/operations/{operation} until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.

Fields
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
sitesarray of objectsRequired

Each first site with the operation that creates it. Empty when the request listed none.

Fields of each item
operationobjectRequired

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 /corestack/operations/{operation} until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.

Fields
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
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.

Fields of the 202 answer
clusterobjectRequired

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
actionsobjectRequired

What can be done with the CoreCluster now.

Fields
create_environmentobjectRequired

Whether something can be done now and, when it cannot, why not.

Fields
availablebooleanRequired
reasonstring or nullRequired
create_siteobjectRequired

May add grows, true when the CoreCluster is full and would grow first under automatic upgrades.

Fields
availablebooleanRequired
reasonstring or nullRequired
deleteobjectRequired

Whether something can be done now and, when it cannot, why not.

Fields
availablebooleanRequired
reasonstring or nullRequired
upgrade_packageobjectRequired

Adds downgrade, true when a smaller package can be chosen.

Fields
availablebooleanRequired
reasonstring or nullRequired
allowanceobjectRequired

What the package allows.

Fields
cpu_millicoresinteger or null
disk_bytesinteger or null
memory_bytesinteger or null
billingobject

Sent only by GET /corestack/clusters/{cluster}, while billing is on for your company.

Fields
account_idinteger or nullRequired

The billing account the CoreCluster is charged to. Null when nothing charges it yet, or you cannot see the account. At least 1.

capacityobjectRequired

How much of the package the CoreCluster's sites use.

Fields
basisstringRequired

What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).

p95mixedestimate
cpuobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_millicoresinteger
used_p95_millicoresnumber or null
evaluated_atstring or nullRequired

Format: date-time.

levelstringRequired

The worst level of the meters.

okwarningblocked
memoryobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
used_p95_bytesnumber or null
packageobject or nullRequired

The package the figures are measured against. Null for a CoreCluster with no package.

Fields
coresinteger
keystring
memory_bytesinteger
namestring
sitesobjectRequired
Fields
countintegerRequired
environmentsintegerRequired
storageobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
provisioned_bytesnumber or null
created_atstring or nullRequired

Format: date-time.

created_byobject or any or nullRequired
environmentsintegerRequired

How many environments besides production the CoreCluster has.

idintegerRequired

The {cluster} of every /corestack/clusters/{cluster} endpoint. At least 1.

kindstringRequired

customer for a CoreCluster of your own.

customerplatform
labelstringRequired
locationobjectRequired
Fields
archstring
arm64amd64
labelstring

Where the CoreCluster runs.

logsobject or nullRequired

How much log storage the CoreCluster uses. Null when its logs are not collected.

namestringRequired
operationobject or any or nullRequired

The change running on the CoreCluster now, or the one that left it failed. Null otherwise.

packageobject or nullRequired

The CoreCluster's package. Null when it has none, and while packages are off for your company.

Fields
coresinteger
keystring
namestring
pending_changesobjectRequired

The changes waiting for the next maintenance window of the CoreCluster's sites.

Fields
countinteger
window_starts_atstring or null

Format: date-time.

ready_atstring or nullRequired

Format: date-time.

regionobjectRequired
Fields
keystringRequired

The region key, as a create takes it.

labelstringRequired
placestringRequired
reservedobjectRequired

What the sizes of the CoreCluster's sites add up to.

Fields
cpu_limit_millicoresinteger
cpu_request_millicoresinteger
disk_bytesinteger
memory_limit_bytesinteger
memory_request_bytesinteger
sitesobjectRequired

How many sites the CoreCluster has, and how they are doing.

Fields
applyingintegerRequired
degradedintegerRequired
downintegerRequired
environmentsintegerRequired

Environments besides production.

healthyintegerRequired
liveintegerRequired

Sites with a domain attached.

previewintegerRequired

Sites with no domain attached yet.

totalintegerRequired
unknownintegerRequired
slugstringRequired

Made from the name when the CoreCluster is created. It never changes.

snapshotsobjectRequired

The short form of the CoreCluster's snapshot settings and storage.

Fields
frequencystring
over_quotaboolean
pruned_recentlyboolean
quota_bytesinteger or null
retention_daysinteger or null
usage_bytesinteger or null
ssh_hoststringRequired

The address the CoreCluster's sites are reached on over SSH.

statestringRequired
creatingreadydegradedmigratingdeletingfailed
state_labelstringRequired
state_reasonstring or nullRequired

Why the CoreCluster is degraded, migrating or failed, in plain words.

syncedobjectRequired

When the list of sites, the usage and the live status were last read.

Fields
inventory_atstring or null

Format: date-time.

live_atstring or null

Format: date-time.

usage_atstring or null

Format: date-time.

usageobjectRequired

What the sites use now. A figure is null where nothing was measured.

Fields
cpu_millicoresnumber or null
disk_used_bytesnumber or null
memory_bytesnumber or null
observed_atstring or null

Format: date-time.

sourcestring or null
operationobjectRequired

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 /corestack/operations/{operation} until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.

Fields
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
sitesarray of objectsRequired

Each first site with the operation that creates it. Empty when the request listed none.

Fields of each item
operationobjectRequired

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 /corestack/operations/{operation} until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.

Fields
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
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.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
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.
409cluster_busyAnother change to the cluster is running. Wait for it to finish, then try again.
409compute_blockedThere is no server capacity for this size at the moment. Choose another size, or contact support.
409duplicateThe same thing already exists here. Use the existing one, or choose another name or value.
409region_unavailableThe region has no room for this at the moment. Choose another region, or try again later.
422invalidFix the field named in field; errors says why.
422runtime_not_adoptedA Node.js version cannot be chosen for a new site here yet. Leave it out to use the default.
429rate_limitedWait for the seconds in Retry-After.
502noneRead the message; it says what happened.
503temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X POST https://manage.corefinity.com/api/corestack/clusters \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "compute_family": "general",
    "name": "Northwind UK 2",
    "package": "xsmall",
    "region": "uk"
  }'
{
  "cluster": {
    "actions": {
      "create_environment": {
        "available": false,
        "reason": "This cluster is still being created"
      },
      "create_site": {
        "available": false,
        "reason": "This cluster is still being created"
      },
      "delete": {
        "available": false,
        "reason": "This cluster is still being created"
      },
      "upgrade_package": {
        "available": false,
        "downgrade": false,
        "reason": "This cluster is still being created"
      }
    },
    "allowance": {
      "cpu_millicores": 4000,
      "disk_bytes": 214748364800,
      "memory_bytes": 17179869184
    },
    "capacity": {
      "basis": "estimate",
      "cpu": {
        "capacity_millicores": 4000,
        "level": "ok",
        "percent": 0,
        "used_p95_millicores": 0
      },
      "evaluated_at": null,
      "level": "ok",
      "memory": {
        "capacity_bytes": 17179869184,
        "level": "ok",
        "percent": 0,
        "used_p95_bytes": 0
      },
      "package": {
        "cores": 4,
        "key": "xsmall",
        "memory_bytes": 17179869184,
        "name": "Extra small"
      },
      "sites": {
        "count": 0,
        "environments": 0
      },
      "storage": {
        "capacity_bytes": 214748364800,
        "level": "ok",
        "percent": 0,
        "provisioned_bytes": 0
      }
    },
    "created_at": "2026-11-14T10:00:00Z",
    "created_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "environments": 0,
    "id": 1018,
    "kind": "customer",
    "label": "Northwind UK 2",
    "location": {
      "arch": "arm64",
      "label": "London (europe-west2)"
    },
    "logs": null,
    "name": "Northwind UK 2",
    "operation": {
      "id": 5130,
      "scope": "cluster",
      "status": "committed",
      "status_label": "Waiting for the platform",
      "summary": "New cluster",
      "to_version": null,
      "type": "cluster_create",
      "type_label": "New cluster"
    },
    "package": {
      "cores": 4,
      "key": "xsmall",
      "name": "Extra small"
    },
    "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": 0,
      "cpu_request_millicores": 0,
      "disk_bytes": 0,
      "memory_limit_bytes": 0,
      "memory_request_bytes": 0
    },
    "sites": {
      "applying": 0,
      "degraded": 0,
      "down": 0,
      "environments": 0,
      "healthy": 0,
      "live": 0,
      "preview": 0,
      "total": 0,
      "unknown": 0
    },
    "slug": "northwind-uk-2",
    "snapshots": {
      "frequency": "6h",
      "over_quota": false,
      "pruned_recently": false,
      "quota_bytes": 429496729600,
      "retention_days": 30,
      "usage_bytes": null
    },
    "ssh_host": "ssh-northwind-uk-2.example.net",
    "state": "creating",
    "state_label": "Creating",
    "state_reason": null,
    "synced": {
      "inventory_at": "2026-11-14T10:00:00Z",
      "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": null,
    "can_retry": false,
    "cluster": {
      "id": 1018,
      "name": "Northwind UK 2"
    },
    "committed_at": "2026-11-14T10:00:01Z",
    "completed_at": null,
    "created_at": "2026-11-14T10:00:00Z",
    "environment": null,
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5130,
    "install": null,
    "label": "SSH gateway ready",
    "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": "committed",
    "status_label": "Publishing the SSH gateway",
    "step": "gateway_ready",
    "steps": [
      {
        "key": "requested",
        "label": "Requested",
        "state": "done"
      },
      {
        "key": "gateway_ready",
        "label": "SSH gateway ready",
        "state": "current"
      },
      {
        "key": "ready",
        "label": "Ready",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "New cluster",
    "to_version": null,
    "type": "cluster_create",
    "type_label": "New cluster"
  },
  "sites": []
}
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