CorefinityCorefinityDocs
Open the Control PanelControl Panel
Environments · 3 of 5

Create a staging environment

Adds a staging environment to the site, protected by HTTP authentication from the start, with the data source chooses. Follow operation.id until it completes; credentials is the generated HTTP authentication login, answered once with Cache-Control: no-store.

POST/api/corestack/sites/{site}/environments
  • Needs exec as well: To be shown the generated HTTP authentication password in credentials. Without it the create still succeeds and the password is null.
  • Needs deploy as well: The environment is built from a git branch, which deploys that branch.

Path parameters

siteintegerRequired

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

Body

mariadb_versionstring

The site's own version when left out.

namestringRequired

A label of 1 to 40 characters without <, > or control characters. Spaces, tabs and line breaks around it are taken off first and do not count.

node_acknowledgearray of strings

Send ["eol"] to accept a Node.js major that is past its end of life. Up to 1 items.

eol
node_majorinteger

The Node.js major to run, while Node.js is on for your company. 1 to 99.

php_versionstring

The site's own version when left out.

slugstring

The short name used in the environment's address: 2 to 16 lower-case letters, digits or dashes, starting with a letter. Made from name when left out.

sourceobjectRequired

Where the environment's data comes from, chosen by type. Each kind takes its own fields only; a field of another kind is refused 422 on that field.

start_from_templateboolean

True to start from your company's deployment template, while templates are on. Defaults to false.

tierstring

The tier, for a site in a CoreCluster. The site's own tier when left out. Refused on a CoreStack site, which takes uat_size; never sent beside uat_size.

uat_sizestring

The staging size, for a CoreStack site: a key of the staging sizes. Refused on a site in a CoreCluster.

Returns

201 The environment is being created. Follow operation.id.

202 The environment was accepted and waits: another change holds the cluster, or the platform's answer is still being confirmed. operation.status is pending. Follow operation.id. Poll the operation until it finishes.

Fields of the 201 answer
credentialsobject or any or nullRequired
environmentobjectRequired

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.

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
Fields of the 202 answer
credentialsobject or any or nullRequired
environmentobjectRequired

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.

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

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.
409cleaning_upThe site, the environment or its last restore is still being cleaned up or removed. Try again in a few minutes.
409deletedThe site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored.
409duplicateThe same thing already exists here. Use the existing one, or choose another name or value.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
409provisioningThe site is still being created. Try again in a few minutes.
409site_unadoptedThis site is not ready to be changed from the Control Panel yet. Contact support.
409source_busyThe environment to copy from is busy with another change, or is being deleted. Nothing was copied. Wait, then try again.
422invalidFix the field named in field; errors says why.
422snapshot_transferA saved snapshot can be copied only to an environment on the same servers for now. Copy the live environment instead, or restore the snapshot first.
429rate_limitedWait for the seconds in Retry-After.
502noneRead the message; it says what happened.
503tier_cluster_missingThe platform has no compute cluster for this here yet. Contact support.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/environments \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Review",
    "slug": "review",
    "source": {
      "environment_id": 1043,
      "scope": "files_db",
      "type": "clone"
    }
  }'
{
  "credentials": {
    "password": "Example-generated-password-1",
    "revealed_at": "2026-11-10T00:59:39Z",
    "rule_id": 3120,
    "user_id": 3121,
    "username": "example"
  },
  "environment": {
    "access_summary": {
      "apply_state": "applied",
      "company_keys": 0,
      "keys": 0,
      "users": 1
    },
    "actions": {
      "apply_pending_now": {
        "available": false,
        "reason": "Scheduled maintenance is switched off at the moment"
      },
      "attach_domain": {
        "available": false,
        "reason": "The site is still being created"
      },
      "change_url": {
        "available": false,
        "reason": "Domains are switched off at the moment"
      },
      "clone": {
        "available": false,
        "reason": "This environment is still being created"
      },
      "create_environment": {
        "available": true,
        "reason": null
      },
      "delete": {
        "available": true,
        "reason": null
      },
      "go_live": {
        "available": false,
        "reason": "The site is still being created"
      },
      "maintenance": {
        "available": false,
        "reason": "This site is still being created"
      },
      "push_to_live": {
        "available": false,
        "reason": "This environment is still being created"
      },
      "restore_deleted": {
        "available": false,
        "reason": "Environments are removed at once. Recreate it from the final snapshot."
      },
      "terminal": {
        "available": false,
        "reason": "The terminal is available once the site is running"
      }
    },
    "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": "harbourandfinch.example.com",
    "domains_summary": {
      "aliases": 0,
      "dns": "unknown",
      "noindex": false,
      "primary": null,
      "tls": "none",
      "www": null
    },
    "email_summary": {
      "sending_domain": null,
      "state": "preview"
    },
    "environment": {
      "env_id": "rs-northwind-harbourandfinch-example-com--qa",
      "hostname": "harbourandfinch-example-com-qa.northwind.cfstack.example.net",
      "id": 1044,
      "name": "QA",
      "role": "staging",
      "role_label": "Staging",
      "slug": "qa"
    },
    "environments": [
      {
        "env_id": "rs-northwind-harbourandfinch-example-com",
        "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
        "id": 1042,
        "name": "Production",
        "role": "production",
        "role_label": "Production",
        "slug": "production"
      },
      {
        "env_id": "rs-northwind-harbourandfinch-example-com--staging",
        "hostname": "harbourandfinch-example-com-staging.northwind.cfstack.example.net",
        "id": 1043,
        "name": "Staging",
        "role": "staging",
        "role_label": "Staging",
        "slug": "staging"
      },
      {
        "env_id": "rs-northwind-harbourandfinch-example-com--qa",
        "hostname": "harbourandfinch-example-com-qa.northwind.cfstack.example.net",
        "id": 1044,
        "name": "QA",
        "role": "staging",
        "role_label": "Staging",
        "slug": "qa"
      }
    ],
    "final_snapshot_note": "Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.",
    "health": "applying",
    "hosting": {
      "cluster_kind": "customer",
      "label": "CoreCluster Northwind UK 1"
    },
    "http_auth_summary": {
      "apply_state": "applied",
      "enabled": true,
      "rules": 1,
      "users": 1
    },
    "id": 1044,
    "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.4"
    },
    "mode": "staging",
    "mode_label": "No domain",
    "operation": {
      "id": 5120,
      "scope": "site",
      "status": "committed",
      "status_label": "Waiting for the platform",
      "summary": "New environment",
      "to_version": null,
      "type": "env_create",
      "type_label": "New environment"
    },
    "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://harbourandfinch-example-com-qa.northwind.cfstack.example.net",
    "preview": {
      "label": "Platform address",
      "protected": true,
      "url": "https://harbourandfinch-example-com-qa.northwind.cfstack.example.net"
    },
    "primary_url": null,
    "production_hosts": [],
    "provisioning": null,
    "removed": false,
    "restore": null,
    "settings": {
      "auto_deploy": false,
      "http_auth_enabled": true,
      "scheduled_snapshots": false
    },
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "site_id": "rs-northwind-harbourandfinch-example-com--qa",
    "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 20033 [email protected]",
      "host": "ssh-northwind.example.net",
      "key_management": false,
      "keys": [],
      "port": 20033,
      "sftp_command": "sftp -P 20033 [email protected]",
      "tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20033 [email protected]",
      "user": "web",
      "users": 1
    },
    "tier": "S",
    "uat_size": 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": 1017,
      "name": "Northwind UK 1"
    },
    "committed_at": "2026-11-10T00:59:39Z",
    "completed_at": null,
    "created_at": "2026-11-10T00:59:39Z",
    "environment": {
      "env_id": "rs-northwind-harbourandfinch-example-com--qa",
      "hostname": "harbourandfinch-example-com-qa.northwind.cfstack.example.net",
      "id": 1044,
      "name": "QA",
      "role": "staging",
      "role_label": "Staging",
      "slug": "qa"
    },
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": false,
    "id": 5120,
    "install": null,
    "label": "Picked up by the platform",
    "notes": [],
    "parent_operation_id": null,
    "requested_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "reset_target": null,
    "result": null,
    "result_state": "none",
    "retried_by_operation_id": null,
    "retries_operation_id": null,
    "retry_requires": null,
    "revealed": null,
    "scope": "site",
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1044
    },
    "status": "committed",
    "status_label": "Waiting for the platform",
    "step": "picked_up",
    "steps": [
      {
        "key": "reserved",
        "label": "Port and address reserved",
        "state": "done"
      },
      {
        "key": "namespace",
        "label": "Place on the platform created",
        "state": "done"
      },
      {
        "key": "dns",
        "label": "Address published",
        "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": "Environment started",
        "state": "todo"
      },
      {
        "key": "seeded",
        "label": "Site prepared",
        "state": "todo"
      },
      {
        "key": "ready",
        "label": "Ready",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "New environment",
    "to_version": null,
    "type": "env_create",
    "type_label": "New environment"
  }
}
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