Create a site
Creates a site with its environments, on a Corefinity platform in a region (with a package) or in one of your CoreClusters (sized by tier). This opens a contract for the site. The answer is 201 when the create has started, or 202 while it waits for room; follow operation.id until it completes.
- Needs
execas well: To be shown the generated HTTP authentication passwords incredentials. Without it the create still succeeds and each password is null.
Body
The server type: Standard (general) or Performance (optimised).
generaloptimisedThe environments to create with the site. May be empty or left out.
Fields of each item
On a Corefinity platform: this is the environment the package includes. At most one.
The environment's name, 40 characters at most, not blank, with no < or > and no control characters. Each name must be different, and none may be a reserved name such as production.
How the environment starts. Only {"type": "empty"} is taken at create.
Fields
emptyIn a CoreCluster: the environment's size. Left out, the site's tier. Refused on a Corefinity platform.
On a Corefinity platform, and required there: the environment's size. Magento 2 takes medium or large, Shopware small, medium or large. Refused in a CoreCluster.
xsmallsmallmediumlargeWith a platform placement, and required then: the package key, such as cs4. Refused with a cluster placement.
Where the site runs.
Fields
With cluster, and required then: the id of your CoreCluster. At least 1.
platform for a Corefinity platform in a region; cluster for one of your CoreClusters.
platformclusterWith platform, and required then: the region key, such as uk (2 to 4 letters).
The site to create.
Fields
What the chosen line asks you to acknowledge.
eolThe key of a line from the application versions list. Left out, the recommended line. Taken only while application versions are on for your company.
fresh installs the platform; empty creates a site for your own code.
freshemptyThe site's public domain in lower case, without www. You choose www or not when you attach the domain. Up to 253 characters.
The edition of the line, such as open_source. Taken only while application versions are on for your company.
Settings of a fresh install, read only when content is fresh. All are optional; a field that is not listed here is refused.
Fields
The admin's email address, 190 characters at most, with no space, quote, <, > or backslash. It is saved in lower case. Left out, the platform's default, else your own address. Format: email.
3 to 32 characters: a lower-case letter first, then lower-case letters, digits or _. admin is refused. Left out, the platform's default, else siteadmin.
Taken only for a platform whose fresh install has a currency, and then one of the currencies it offers; refused as a field that is not part of the request for every other platform.
One of the locales the platform installs, en_GB or en_US unless the platform offers its own list. Left out, the platform's default, else en_GB.
The site's title, 100 characters at most, with no control characters (a line break is one). Left out, or blank (a blank title is read as left out), the platform's default, else the domain.
Create the site behind HTTP authentication, with one whole-site rule and a generated login. Defaults to false.
Left out, the platform's default.
["eol"] to choose a major that no longer receives fixes; otherwise leave it out or send []. Up to 1 items.
eolThe Node.js major version for the site, as a whole number (22, never "22"), and one of the majors offered to new sites of the platform. Left out, the default major. Refused while choosing a Node.js version is switched off, and where a new site cannot take one yet. 1 to 99.
Such as 8.3. Left out, the platform's default.
wordpress, magento2, laravel, shopware, or another platform offered to your company.
Shopware only: whether search is on.
The size, such as S, M or L. Required in a CoreCluster; refused on a Corefinity platform, where the package sets the size.
Magento 2 only, where offered: start the site with Varnish.
Fields
Returns
201 The create has started.
202 The create is accepted and has not started yet. state is capacity_being_added while it waits for room to be added; otherwise it is creating and the operation is still pending. Poll the operation until it finishes.
Fields of the 201 answer
The cluster the site was placed on. Other fields may be present. A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.
Fields
The generated HTTP authentication logins of the site and its environments.
Fields of each item
Null when the token does not hold the exec scope.
Sent when the password was withheld.
Fields
Format: date-time.
At least 1.
At least 1.
Fields of each item
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
healthydegradeddownapplyingunknownnot_liveFields
customer for a site in one of your CoreClusters, platform for a standalone CoreStack site.
The site row id, the {site} of every /corestack/sites/{site} endpoint.
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.
coreclustercorestackFields
Fields
production once a domain is attached, staging before.
productionstagingunknownThe change running on the row now, or null.
The package of a standalone CoreStack site, with its key, code and name. Null for a CoreCluster site.
The changes waiting for the row's next maintenance window.
Fields
Fields
Fields
The row's own address on the platform.
The restore running on the row now, or null.
The site the row belongs to. For a production row, the row itself.
The row's platform identifier.
A summary of the row's snapshots.
Fields
The size of the row, such as S, M or L.
The size of a staging environment. Null for a production row.
Fields
What you can do with the row now. Each entry says whether it is available and, when not, why.
A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.
Fields
How many scheduled tasks and redirects the row has, each while its feature is on.
How to connect to the database. The password is never in this answer.
When the site was deleted and until when it can be restored. Null for a site that is not deleted.
Fields of each item
The environment's platform identifier.
The environment's own address on the platform.
The site row id, the {site} every /corestack/sites/{site} endpoint takes.
The environment's role, such as production or staging.
Where the row is in its life, such as active or deleted.
The status last read from the cluster. Null until one has been read.
The row's most recent operations.
Fields of each item
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 row's platform address, and whether HTTP authentication protects it.
The PHP, MariaDB and Node.js versions with the versions the row can change to.
The environment's own switches, as PATCH / sets them.
Fields
Whether the environment deploys automatically from Git.
Whether HTTP authentication is on for the whole environment.
Whether scheduled snapshots are on.
How to connect over SSH and SFTP.
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.
Sent when the environment waits for the site to be ready.
Sent with queued environments.
The operation creating the site. This answer writes its times with a +00:00 offset; reading the operation by its id answers them in UTC with Z.
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.
Sent when the site was created before the company had a payment method: method_needed, add_by, message and href.
The path of the progress page in the Control Panel.
Always null in this answer.
The endpoint that reveals the fresh install's admin login once. Sent only for a fresh install with an admin login.
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
healthydegradeddownapplyingunknownnot_liveFields
customer for a site in one of your CoreClusters, platform for a standalone CoreStack site.
The site row id, the {site} of every /corestack/sites/{site} endpoint.
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.
coreclustercorestackFields
Fields
production once a domain is attached, staging before.
productionstagingunknownThe change running on the row now, or null.
The package of a standalone CoreStack site, with its key, code and name. Null for a CoreCluster site.
The changes waiting for the row's next maintenance window.
Fields
Fields
Fields
The row's own address on the platform.
The restore running on the row now, or null.
The site the row belongs to. For a production row, the row itself.
The row's platform identifier.
A summary of the row's snapshots.
Fields
The size of the row, such as S, M or L.
The size of a staging environment. Null for a production row.
Fields
What you can do with the row now. Each entry says whether it is available and, when not, why.
A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.
Fields
How many scheduled tasks and redirects the row has, each while its feature is on.
How to connect to the database. The password is never in this answer.
When the site was deleted and until when it can be restored. Null for a site that is not deleted.
Fields of each item
The environment's platform identifier.
The environment's own address on the platform.
The site row id, the {site} every /corestack/sites/{site} endpoint takes.
The environment's role, such as production or staging.
Where the row is in its life, such as active or deleted.
The status last read from the cluster. Null until one has been read.
The row's most recent operations.
Fields of each item
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 row's platform address, and whether HTTP authentication protects it.
The PHP, MariaDB and Node.js versions with the versions the row can change to.
The environment's own switches, as PATCH / sets them.
Fields
Whether the environment deploys automatically from Git.
Whether HTTP authentication is on for the whole environment.
Whether scheduled snapshots are on.
How to connect over SSH and SFTP.
creating, or capacity_being_added while the create waits for room to be added. No other value is sent.
creatingcapacity_being_addedFields of the 202 answer
The cluster the site was placed on. Other fields may be present. A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.
Fields
The generated HTTP authentication logins of the site and its environments.
Fields of each item
Null when the token does not hold the exec scope.
Sent when the password was withheld.
Fields
Format: date-time.
At least 1.
At least 1.
Fields of each item
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
healthydegradeddownapplyingunknownnot_liveFields
customer for a site in one of your CoreClusters, platform for a standalone CoreStack site.
The site row id, the {site} of every /corestack/sites/{site} endpoint.
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.
coreclustercorestackFields
Fields
production once a domain is attached, staging before.
productionstagingunknownThe change running on the row now, or null.
The package of a standalone CoreStack site, with its key, code and name. Null for a CoreCluster site.
The changes waiting for the row's next maintenance window.
Fields
Fields
Fields
The row's own address on the platform.
The restore running on the row now, or null.
The site the row belongs to. For a production row, the row itself.
The row's platform identifier.
A summary of the row's snapshots.
Fields
The size of the row, such as S, M or L.
The size of a staging environment. Null for a production row.
Fields
What you can do with the row now. Each entry says whether it is available and, when not, why.
A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.
Fields
How many scheduled tasks and redirects the row has, each while its feature is on.
How to connect to the database. The password is never in this answer.
When the site was deleted and until when it can be restored. Null for a site that is not deleted.
Fields of each item
The environment's platform identifier.
The environment's own address on the platform.
The site row id, the {site} every /corestack/sites/{site} endpoint takes.
The environment's role, such as production or staging.
Where the row is in its life, such as active or deleted.
The status last read from the cluster. Null until one has been read.
The row's most recent operations.
Fields of each item
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 row's platform address, and whether HTTP authentication protects it.
The PHP, MariaDB and Node.js versions with the versions the row can change to.
The environment's own switches, as PATCH / sets them.
Fields
Whether the environment deploys automatically from Git.
Whether HTTP authentication is on for the whole environment.
Whether scheduled snapshots are on.
How to connect over SSH and SFTP.
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.
Sent when the environment waits for the site to be ready.
Sent with queued environments.
The operation creating the site. This answer writes its times with a +00:00 offset; reading the operation by its id answers them in UTC with Z.
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.
Sent when the site was created before the company had a payment method: method_needed, add_by, message and href.
The path of the progress page in the Control Panel.
Always null in this answer.
The endpoint that reveals the fresh install's admin login once. Sent only for a fresh install with an admin login.
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
healthydegradeddownapplyingunknownnot_liveFields
customer for a site in one of your CoreClusters, platform for a standalone CoreStack site.
The site row id, the {site} of every /corestack/sites/{site} endpoint.
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.
coreclustercorestackFields
Fields
production once a domain is attached, staging before.
productionstagingunknownThe change running on the row now, or null.
The package of a standalone CoreStack site, with its key, code and name. Null for a CoreCluster site.
The changes waiting for the row's next maintenance window.
Fields
Fields
Fields
The row's own address on the platform.
The restore running on the row now, or null.
The site the row belongs to. For a production row, the row itself.
The row's platform identifier.
A summary of the row's snapshots.
Fields
The size of the row, such as S, M or L.
The size of a staging environment. Null for a production row.
Fields
What you can do with the row now. Each entry says whether it is available and, when not, why.
A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.
Fields
How many scheduled tasks and redirects the row has, each while its feature is on.
How to connect to the database. The password is never in this answer.
When the site was deleted and until when it can be restored. Null for a site that is not deleted.
Fields of each item
The environment's platform identifier.
The environment's own address on the platform.
The site row id, the {site} every /corestack/sites/{site} endpoint takes.
The environment's role, such as production or staging.
Where the row is in its life, such as active or deleted.
The status last read from the cluster. Null until one has been read.
The row's most recent operations.
Fields of each item
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 row's platform address, and whether HTTP authentication protects it.
The PHP, MariaDB and Node.js versions with the versions the row can change to.
The environment's own switches, as PATCH / sets them.
Fields
Whether the environment deploys automatically from Git.
Whether HTTP authentication is on for the whole environment.
Whether scheduled snapshots are on.
How to connect over SSH and SFTP.
creating, or capacity_being_added while the create waits for room to be added. No other value is sent.
creatingcapacity_being_addedIf 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 | forbidden | The person is not allowed to do this. |
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 | cleaning_up | The site, the environment or its last restore is still being cleaned up or removed. Try again in a few minutes. |
409 | duplicate | The same thing already exists here. Use the existing one, or choose another name or value. |
409 | no_payment_method | There is no payment method on the account. Add a card or a Direct Debit mandate first. |
409 | no_platform_cluster | The region has no CoreStack platform yet. Choose another region. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
502 | none | Read the message; it says what happened. |
503 | catalogue_unavailable | Application versions are unavailable right now. Try again in a few minutes. |
503 | commerce_check_unavailable | We could not check your Magento Marketplace keys. Try again in a few minutes. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/corestack/sites \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"environments": [],
"package": "cs4",
"placement": {
"kind": "platform",
"region": "uk"
},
"site": {
"content": "fresh",
"domain": "harbourandfinch.example.net",
"http_auth": true,
"php_version": "8.3",
"platform": "wordpress"
}
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites', [
'environments' => [],
'package' => 'cs4',
'placement' => [
'kind' => 'platform',
'region' => 'uk',
],
'site' => [
'content' => 'fresh',
'domain' => 'harbourandfinch.example.net',
'http_auth' => true,
'php_version' => '8.3',
'platform' => 'wordpress',
],
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
environments: [],
package: 'cs4',
placement: {
kind: 'platform',
region: 'uk',
},
site: {
content: 'fresh',
domain: 'harbourandfinch.example.net',
http_auth: true,
php_version: '8.3',
platform: 'wordpress',
},
}),
});
// 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.post(
"https://manage.corefinity.com/api/corestack/sites",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"environments": [],
"package": "cs4",
"placement": {
"kind": "platform",
"region": "uk",
},
"site": {
"content": "fresh",
"domain": "harbourandfinch.example.net",
"http_auth": True,
"php_version": "8.3",
"platform": "wordpress",
},
},
)
data = res.json() if res.content else None{
"cluster": {
"id": 1009,
"kind": "platform",
"label": "CoreStack",
"name": "CoreStack",
"state": "ready",
"state_label": "Ready"
},
"company_enabled": false,
"credentials": [
{
"password": "Example-staging-2026",
"revealed_at": "2026-11-19T09:00:00Z",
"rule_id": 3151,
"user_id": 3171,
"username": "example"
}
],
"environments": [
{
"environment": {
"access_summary": {
"apply_state": "applied",
"company_keys": 0,
"keys": 0,
"users": 1
},
"actions": {
"attach_domain": {
"available": true,
"reason": null
},
"delete": {
"available": true,
"reason": null
},
"restore_deleted": {
"available": false,
"reason": "This site is not deleted"
}
},
"adoption": "adopted",
"cloudflare": {
"connected": false,
"zone": null
},
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"commands": [],
"compute_family": "general",
"counts": {
"crons": 1
},
"crons_enabled": false,
"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": "journal.harbourandfinch.example.com",
"domains_summary": {
"aliases": 0,
"dns": "unknown",
"noindex": false,
"primary": "journal.harbourandfinch.example.com",
"tls": "none",
"www": null
},
"email_summary": {
"sending_domain": null,
"state": "preview"
},
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1052,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"environments": [
{
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1052,
"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": 1052,
"kind": "corestack",
"lifecycle": "provisioning",
"limits": {
"cpu_millicores": 2000,
"disk_bytes": 10737418240,
"memory_bytes": 4294967296
},
"logs": null,
"maintenance": {
"bypass_corefinity": 1,
"bypass_ips": [],
"enabled": false,
"since": null
},
"mariadb": {
"version": "11.8"
},
"mode": "staging",
"mode_label": "No domain",
"operation": null,
"operations": [],
"package": null,
"pending_changes": {
"count": 0,
"outcome_at": null,
"state": null,
"window_starts_at": null
},
"php": {
"version": "8.3"
},
"platform": {
"key": "wordpress",
"label": "WordPress"
},
"platform_url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"preview": {
"label": "Platform address",
"protected": false,
"url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"
},
"primary_url": null,
"production_hosts": [],
"provisioning": null,
"removed": false,
"restore": null,
"settings": {
"auto_deploy": false,
"http_auth_enabled": false,
"scheduled_snapshots": true
},
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1051
},
"site_id": "rs-northwind-journal-harbourandfinch-example-com",
"snapshots": {
"count": 0,
"effective_frequency": "off",
"effective_label": "Off",
"latest": null,
"latest_ready_at": null,
"next_scheduled_at": null,
"overridden": false,
"stored_gb": 0
},
"ssh": {
"command": "ssh -p 20031 [email protected]",
"host": "ssh-northwind.example.net",
"key_management": false,
"keys": [],
"port": 20031,
"sftp_command": "sftp -P 20031 [email protected]",
"tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20031 [email protected]",
"user": "web",
"users": 1
},
"tier": "xsmall",
"uat_size": null,
"usage": {
"cpu_millicores": 180,
"disk_used_bytes": 2147483648,
"memory_bytes": 912261120,
"observed_at": "2026-11-24T09:10:00Z",
"source": "live"
}
},
"operation": {
"applied_at": null,
"can_retry": false,
"cluster": {
"id": 1009,
"name": "CoreStack"
},
"committed_at": "2026-11-19T09:00:02+00:00",
"completed_at": null,
"created_at": "2026-11-19T09:00:00+00:00",
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1052,
"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": 2012,
"name": "Daniel Reyes"
},
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"scope": "site",
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1052
},
"status": "pending",
"status_label": "Saving change",
"steps": [
{
"key": "reserved",
"label": "Port and address reserved",
"state": "done"
},
{
"key": "committed",
"label": "Saved to the platform",
"state": "done"
},
{
"key": "picked_up",
"label": "Picked up by the platform",
"state": "current"
},
{
"key": "starting",
"label": "Site started",
"state": "todo"
},
{
"key": "ready",
"label": "Ready",
"state": "todo"
}
],
"subject": null,
"summary": "New environment Staging",
"to_version": null,
"type": "env_create",
"type_label": "New environment"
}
}
],
"operation": {
"applied_at": null,
"can_retry": false,
"cluster": {
"id": 1009,
"name": "CoreStack"
},
"committed_at": "2026-11-19T09:00:02+00:00",
"completed_at": null,
"created_at": "2026-11-19T09:00:00+00:00",
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1051,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"error": null,
"failure_reason": null,
"from_version": null,
"hot": false,
"id": 5120,
"notes": [],
"parent_operation_id": null,
"requested_by": {
"id": 2012,
"name": "Daniel Reyes"
},
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"scope": "site",
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1051
},
"status": "committed",
"status_label": "Waiting for the platform",
"steps": [
{
"key": "reserved",
"label": "Port and address reserved",
"state": "done"
},
{
"key": "committed",
"label": "Saved to the platform",
"state": "done"
},
{
"key": "picked_up",
"label": "Picked up by the platform",
"state": "current"
},
{
"key": "starting",
"label": "Site started",
"state": "todo"
},
{
"key": "ready",
"label": "Ready",
"state": "todo"
}
],
"subject": null,
"summary": "New site journal.harbourandfinch.example.com",
"to_version": null,
"type": "provision",
"type_label": "New site"
},
"payment": null,
"progress_href": "/managed-websites/sites/1051/progress",
"quote": null,
"site": {
"access_summary": {
"apply_state": "applied",
"company_keys": 0,
"keys": 0,
"users": 1
},
"actions": {
"attach_domain": {
"available": true,
"reason": null
},
"delete": {
"available": true,
"reason": null
},
"restore_deleted": {
"available": false,
"reason": "This site is not deleted"
}
},
"adoption": "adopted",
"cloudflare": {
"connected": false,
"zone": null
},
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"commands": [],
"compute_family": "general",
"counts": {
"crons": 1
},
"crons_enabled": false,
"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": "journal.harbourandfinch.example.com",
"domains_summary": {
"aliases": 0,
"dns": "unknown",
"noindex": false,
"primary": "journal.harbourandfinch.example.com",
"tls": "none",
"www": null
},
"email_summary": {
"sending_domain": null,
"state": "preview"
},
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1051,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"environments": [
{
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1051,
"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": 1051,
"kind": "corestack",
"lifecycle": "provisioning",
"limits": {
"cpu_millicores": 2000,
"disk_bytes": 10737418240,
"memory_bytes": 4294967296
},
"logs": null,
"maintenance": {
"bypass_corefinity": 1,
"bypass_ips": [],
"enabled": false,
"since": null
},
"mariadb": {
"version": "11.8"
},
"mode": "staging",
"mode_label": "No domain",
"operation": null,
"operations": [],
"package": null,
"pending_changes": {
"count": 0,
"outcome_at": null,
"state": null,
"window_starts_at": null
},
"php": {
"version": "8.3"
},
"platform": {
"key": "wordpress",
"label": "WordPress"
},
"platform_url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"preview": {
"label": "Platform address",
"protected": false,
"url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"
},
"primary_url": null,
"production_hosts": [],
"provisioning": null,
"removed": false,
"restore": null,
"settings": {
"auto_deploy": false,
"http_auth_enabled": false,
"scheduled_snapshots": true
},
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1051
},
"site_id": "rs-northwind-journal-harbourandfinch-example-com",
"snapshots": {
"count": 0,
"effective_frequency": "off",
"effective_label": "Off",
"latest": null,
"latest_ready_at": null,
"next_scheduled_at": null,
"overridden": false,
"stored_gb": 0
},
"ssh": {
"command": "ssh -p 20031 [email protected]",
"host": "ssh-northwind.example.net",
"key_management": false,
"keys": [],
"port": 20031,
"sftp_command": "sftp -P 20031 [email protected]",
"tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20031 [email protected]",
"user": "web",
"users": 1
},
"tier": "cs4",
"uat_size": null,
"usage": {
"cpu_millicores": 180,
"disk_used_bytes": 2147483648,
"memory_bytes": 912261120,
"observed_at": "2026-11-24T09:10:00Z",
"source": "live"
}
},
"state": "creating"
}{
"cluster": {
"id": 1009,
"kind": "platform",
"label": "CoreStack",
"name": "CoreStack",
"state": "ready",
"state_label": "Ready"
},
"company_enabled": false,
"credentials": [
{
"password": "Example-staging-2026",
"revealed_at": "2026-11-19T09:00:00Z",
"rule_id": 3151,
"user_id": 3171,
"username": "example"
}
],
"environments": [
{
"environment": {
"access_summary": {
"apply_state": "applied",
"company_keys": 0,
"keys": 0,
"users": 1
},
"actions": {
"attach_domain": {
"available": true,
"reason": null
},
"delete": {
"available": true,
"reason": null
},
"restore_deleted": {
"available": false,
"reason": "This site is not deleted"
}
},
"adoption": "adopted",
"cloudflare": {
"connected": false,
"zone": null
},
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"commands": [],
"compute_family": "general",
"counts": {
"crons": 1
},
"crons_enabled": false,
"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": "journal.harbourandfinch.example.com",
"domains_summary": {
"aliases": 0,
"dns": "unknown",
"noindex": false,
"primary": "journal.harbourandfinch.example.com",
"tls": "none",
"www": null
},
"email_summary": {
"sending_domain": null,
"state": "preview"
},
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1052,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"environments": [
{
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1052,
"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": 1052,
"kind": "corestack",
"lifecycle": "provisioning",
"limits": {
"cpu_millicores": 2000,
"disk_bytes": 10737418240,
"memory_bytes": 4294967296
},
"logs": null,
"maintenance": {
"bypass_corefinity": 1,
"bypass_ips": [],
"enabled": false,
"since": null
},
"mariadb": {
"version": "11.8"
},
"mode": "staging",
"mode_label": "No domain",
"operation": null,
"operations": [],
"package": null,
"pending_changes": {
"count": 0,
"outcome_at": null,
"state": null,
"window_starts_at": null
},
"php": {
"version": "8.3"
},
"platform": {
"key": "wordpress",
"label": "WordPress"
},
"platform_url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"preview": {
"label": "Platform address",
"protected": false,
"url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"
},
"primary_url": null,
"production_hosts": [],
"provisioning": null,
"removed": false,
"restore": null,
"settings": {
"auto_deploy": false,
"http_auth_enabled": false,
"scheduled_snapshots": true
},
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1051
},
"site_id": "rs-northwind-journal-harbourandfinch-example-com",
"snapshots": {
"count": 0,
"effective_frequency": "off",
"effective_label": "Off",
"latest": null,
"latest_ready_at": null,
"next_scheduled_at": null,
"overridden": false,
"stored_gb": 0
},
"ssh": {
"command": "ssh -p 20031 [email protected]",
"host": "ssh-northwind.example.net",
"key_management": false,
"keys": [],
"port": 20031,
"sftp_command": "sftp -P 20031 [email protected]",
"tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20031 [email protected]",
"user": "web",
"users": 1
},
"tier": "xsmall",
"uat_size": null,
"usage": {
"cpu_millicores": 180,
"disk_used_bytes": 2147483648,
"memory_bytes": 912261120,
"observed_at": "2026-11-24T09:10:00Z",
"source": "live"
}
},
"operation": {
"applied_at": null,
"can_retry": false,
"cluster": {
"id": 1009,
"name": "CoreStack"
},
"committed_at": "2026-11-19T09:00:02+00:00",
"completed_at": null,
"created_at": "2026-11-19T09:00:00+00:00",
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1052,
"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": 2012,
"name": "Daniel Reyes"
},
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"scope": "site",
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1052
},
"status": "pending",
"status_label": "Saving change",
"steps": [
{
"key": "reserved",
"label": "Port and address reserved",
"state": "done"
},
{
"key": "committed",
"label": "Saved to the platform",
"state": "done"
},
{
"key": "picked_up",
"label": "Picked up by the platform",
"state": "current"
},
{
"key": "starting",
"label": "Site started",
"state": "todo"
},
{
"key": "ready",
"label": "Ready",
"state": "todo"
}
],
"subject": null,
"summary": "New environment Staging",
"to_version": null,
"type": "env_create",
"type_label": "New environment"
}
}
],
"operation": {
"applied_at": null,
"can_retry": false,
"cluster": {
"id": 1009,
"name": "CoreStack"
},
"committed_at": "2026-11-19T09:00:02+00:00",
"completed_at": null,
"created_at": "2026-11-19T09:00:00+00:00",
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1051,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"error": null,
"failure_reason": null,
"from_version": null,
"hot": false,
"id": 5120,
"notes": [],
"parent_operation_id": null,
"requested_by": {
"id": 2012,
"name": "Daniel Reyes"
},
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"scope": "site",
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1051
},
"status": "pending",
"status_label": "Saving change",
"steps": [
{
"key": "reserved",
"label": "Port and address reserved",
"state": "done"
},
{
"key": "committed",
"label": "Saved to the platform",
"state": "done"
},
{
"key": "picked_up",
"label": "Picked up by the platform",
"state": "current"
},
{
"key": "starting",
"label": "Site started",
"state": "todo"
},
{
"key": "ready",
"label": "Ready",
"state": "todo"
}
],
"subject": null,
"summary": "New site journal.harbourandfinch.example.com",
"to_version": null,
"type": "provision",
"type_label": "New site"
},
"payment": null,
"progress_href": "/managed-websites/sites/1051/progress",
"quote": null,
"site": {
"access_summary": {
"apply_state": "applied",
"company_keys": 0,
"keys": 0,
"users": 1
},
"actions": {
"attach_domain": {
"available": true,
"reason": null
},
"delete": {
"available": true,
"reason": null
},
"restore_deleted": {
"available": false,
"reason": "This site is not deleted"
}
},
"adoption": "adopted",
"cloudflare": {
"connected": false,
"zone": null
},
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"commands": [],
"compute_family": "general",
"counts": {
"crons": 1
},
"crons_enabled": false,
"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": "journal.harbourandfinch.example.com",
"domains_summary": {
"aliases": 0,
"dns": "unknown",
"noindex": false,
"primary": "journal.harbourandfinch.example.com",
"tls": "none",
"www": null
},
"email_summary": {
"sending_domain": null,
"state": "preview"
},
"environment": {
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1051,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"environments": [
{
"env_id": "rs-northwind-journal-harbourandfinch-example-com",
"hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1051,
"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": 1051,
"kind": "corestack",
"lifecycle": "provisioning",
"limits": {
"cpu_millicores": 2000,
"disk_bytes": 10737418240,
"memory_bytes": 4294967296
},
"logs": null,
"maintenance": {
"bypass_corefinity": 1,
"bypass_ips": [],
"enabled": false,
"since": null
},
"mariadb": {
"version": "11.8"
},
"mode": "staging",
"mode_label": "No domain",
"operation": null,
"operations": [],
"package": null,
"pending_changes": {
"count": 0,
"outcome_at": null,
"state": null,
"window_starts_at": null
},
"php": {
"version": "8.3"
},
"platform": {
"key": "wordpress",
"label": "WordPress"
},
"platform_url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net",
"preview": {
"label": "Platform address",
"protected": false,
"url": "https://journal-harbourandfinch-example-com.northwind.cfstack.example.net"
},
"primary_url": null,
"production_hosts": [],
"provisioning": null,
"removed": false,
"restore": null,
"settings": {
"auto_deploy": false,
"http_auth_enabled": false,
"scheduled_snapshots": true
},
"site": {
"domain": "journal.harbourandfinch.example.com",
"id": 1051
},
"site_id": "rs-northwind-journal-harbourandfinch-example-com",
"snapshots": {
"count": 0,
"effective_frequency": "off",
"effective_label": "Off",
"latest": null,
"latest_ready_at": null,
"next_scheduled_at": null,
"overridden": false,
"stored_gb": 0
},
"ssh": {
"command": "ssh -p 20031 [email protected]",
"host": "ssh-northwind.example.net",
"key_management": false,
"keys": [],
"port": 20031,
"sftp_command": "sftp -P 20031 [email protected]",
"tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20031 [email protected]",
"user": "web",
"users": 1
},
"tier": "cs4",
"uat_size": null,
"usage": {
"cpu_millicores": 180,
"disk_used_bytes": 2147483648,
"memory_bytes": 912261120,
"observed_at": "2026-11-24T09:10:00Z",
"source": "live"
}
},
"state": "capacity_being_added"
}{
"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": "cleaning_up",
"message": "This site is being cleaned up. Try again in a minute.",
"reason": "cleaning_up"
}{
"code": "invalid",
"errors": {
"trial": [
"This request contains a field that is not part of it."
]
},
"field": "trial",
"message": "This request contains a field that is not part of it.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"message": "The platform could not be checked just now. Try again in a minute."
}{
"code": "catalogue_unavailable",
"message": "Application versions are unavailable right now. Try again in a few minutes.",
"reason": "catalogue_unavailable"
}Try it is off for this endpointIt can add to your bill. Copy the request and run it yourself when you are sure.