List a site's environments
Lists the site's production row and every environment, what a new environment can be copied from, and whether you can add one. {site} is any row of the site.
Path parameters
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.
Returns
200 The site's environments.
Fields of the 200 answer
Whether something can be done now and, when it cannot, why not.
Fields
Whether something can be done now and, when it cannot, why not.
Fields
Whether something can be done now and, when it cannot, why not.
Fields
The production row first, then every environment.
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.
Only while restores into any environment are on: when the row's data was anonymised. Format: date-time.
Only while restores into any environment are on: how many rows were anonymised.
The row's application version. Only while application versions are on for your company.
The branch a Git environment deploys.
True when the environment could not be created.
Format: date-time.
How the environment is deployed, such as manual or git.
Only where it applies: until when the final snapshot stays restorable.
Only where it applies: what deleting this environment means for its final snapshot.
Such as healthy, applying or unknown.
Fields
Where the row is in its life, such as active, provisioning or deleted.
production once the environment serves its own domain, else staging.
The restore that is running. Null when none is.
Only while restores into any environment are on: the restore the row's data came from. Null when it came from none.
Only while restores into any environment are on: how the row's data was anonymised.
What the environment was copied from. Null for one that started empty.
Fields
Fields
The production row. Null for a site that has staging environments only.
Copies waiting their turn onto the site's rows, each as getQueuedCopy answers it.
Fields of each item
How many copies on the same website are in front of this one. Null once it is no longer in the queue.
When the copy stops waiting. Six hours after it was queued, by default. Format: date-time.
When it started, was cancelled, was refused or expired. Format: date-time.
The id getQueuedCopy and cancelQueuedCopy take. At least 1.
The same in plain words. Null once it has started.
The copy's operation once it has started, for getOperation. At least 1.
When the copy was queued. Format: date-time.
A stable code for why it waits or why it ended, such as target_busy, clone_in_progress, busy, snapshot_slot, cancelled, access_ended or two_factor_required. Null once it has started.
The environment the copy comes from. Null when you may not see that environment (a copy from another website), where message calls it "the environment it copies from", and when it no longer exists.
waiting or starting while it is in the queue; started once the copy runs (follow operation_id); refused when a rule failed as it started, or the access that queued it has ended; expired when it could not start before deadline_at; cancelled.
waitingstartingstartedrefusedexpiredcancelledAn environment of a queued copy. Unlike the shared Named, name is null once the environment is gone.
Fields
The environment's site row id, the {site} of /corestack/sites/{site}. At least 1.
The environment's name. Null for a target that no longer exists.
Fields
At least 1.
Where the site is in its life, such as active or deleted.
Fields
How a new environment is sized. A site in a CoreCluster is sized by tier, and every other field is null. A CoreStack site is sized by uat_size, with the sizes on offer.
Fields
tieruat_sizeThe key of the size to start on: the included size, or the next one up the platform takes. Null when sized by tier.
The staging environment the site's package includes. Null when sized by tier, or when the package includes none.
What to price a size with. Null when sized by tier, and while nothing is charged for the environment.
Only on a Shopware site sized by uat_size: the sizes Shopware does not take, each with why.
Fields of each item
Only on a Shopware site sized by uat_size: the key of each size that can run search.
The staging sizes the request accepts for this site's platform, smallest first. Null when sized by tier.
Fields of each item
The value to send as uat_size.
What a new environment can be copied from.
Fields of each item
Whether something can be done now and, when it cannot, why not.
Fields
One environment of a website, addressed by its site row.
Fields
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.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/sites/1042/environments \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/environments');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/environments', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// 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.get(
"https://manage.corefinity.com/api/corestack/sites/1042/environments",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"branches": {
"available": false,
"reason": "Environments from a git branch are switched off at the moment"
},
"can_create": {
"available": true,
"reason": null
},
"clone": {
"available": true,
"reason": null
},
"environments": [
{
"auto_deploy": false,
"branch": null,
"create_failed": false,
"created_at": "2026-11-10T00:59:38Z",
"created_by": null,
"deploy_mode": "manual",
"env_id": "rs-northwind-harbourandfinch-example-com",
"health": "unknown",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"http_auth": {
"enabled": false,
"users": 0
},
"id": 1042,
"lifecycle": "active",
"mode": "staging",
"mode_label": "No domain",
"name": "Production",
"operation": null,
"platform_url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
"primary_url": null,
"restore": null,
"role": "production",
"role_label": "Production",
"scheduled_snapshots": true,
"slug": "production",
"source": null,
"tier": "S",
"usage_p95": {
"basis": "estimate",
"cpu_millicores": null,
"memory_bytes": null
}
},
{
"auto_deploy": false,
"branch": null,
"create_failed": false,
"created_at": "2026-11-10T00:59:38Z",
"created_by": null,
"deploy_mode": "manual",
"env_id": "rs-northwind-harbourandfinch-example-com--staging",
"final_snapshot_note": "Snapshots are off for this cluster, so no final copy is taken: it cannot be brought back afterwards.",
"health": "unknown",
"hostname": "harbourandfinch-example-com-staging.northwind.cfstack.example.net",
"http_auth": {
"enabled": true,
"users": 0
},
"id": 1043,
"lifecycle": "active",
"mode": "staging",
"mode_label": "No domain",
"name": "Staging",
"operation": null,
"platform_url": "https://harbourandfinch-example-com-staging.northwind.cfstack.example.net",
"primary_url": null,
"restore": null,
"role": "staging",
"role_label": "Staging",
"scheduled_snapshots": false,
"slug": "staging",
"source": null,
"tier": "S",
"usage_p95": {
"basis": "estimate",
"cpu_millicores": null,
"memory_bytes": null
}
}
],
"limits": {
"name_max": 40,
"slug_max": 16
},
"production": {
"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"
},
"queued_copies": [],
"site": {
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"domain": "harbourandfinch.example.com",
"id": 1042,
"lifecycle": "active",
"platform": {
"key": "wordpress",
"label": "WordPress"
}
},
"sizing": {
"by": "tier",
"default": null,
"included": null,
"pricing": null,
"sizes": null
},
"sources": [
{
"can_clone": {
"available": true,
"reason": null
},
"environment": {
"env_id": "rs-northwind-harbourandfinch-example-com",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1042,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
}
},
{
"can_clone": {
"available": true,
"reason": null
},
"environment": {
"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"
}
}
]
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}