CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 8 of 18

List your sites

Every site you can open, one entry per site with its environments, in id order. Paged by cursor: send next_cursor back as cursor; null means the last page.

GET/api/corestack/sites

Query parameters

cluster_idinteger

Only the sites of this CoreCluster. A CoreCluster that is not yours answers 404. At least 1.

platformstring

Only sites of this platform. Only the platforms available to your company are accepted.

wordpresslaravelmagento2shopware5
kindstring

corecluster for sites in one of your CoreClusters, corestack for standalone CoreStack sites.

coreclustercorestack
searchstring

Part of a domain or of an environment name. Up to 120 characters.

app_statusstring

security for sites on an application version that receives security fixes only, eol for sites on an ended version. Accepted only while application versions are on for your company; otherwise it is refused 422 on app_status.

securityeol
limitinteger

Items a page: 1 to 100, default 50.

cursorstring

The next_cursor of the previous answer. One with other characters, or longer than 64, is refused 422 on cursor; any other value that is not a cursor reads the first page.

Returns

200 One page of sites.

Fields of the 200 answer
next_cursorstring or nullRequired

Send as cursor to read the next page. Null on the last page.

sitesarray of objectsRequired
Fields of each item
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
platformobjectRequired
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 nullRequired

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
clusterobjectRequired

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

Fields
idintegerRequired
namestringRequired
covers_sitebooleanRequired

Always true on this endpoint.

environment_countintegerRequired

How many environments the site has besides production.

environmentsarray of objectsRequired

Every row of the site, the production row first.

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

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.
404noneCheck the id. You see only what your account can reach.
422invalidFix the field named in field; errors says why.
429rate_limitedWait 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 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "next_cursor": null,
  "sites": [
    {
      "cluster": {
        "id": 1017,
        "name": "Northwind UK 1"
      },
      "compute_family": "general",
      "covers_site": true,
      "domain": "harbourandfinch.example.com",
      "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"
      },
      "environment_count": 1,
      "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": "staging-harbourandfinch-example-com.northwind.cfstack.example.net",
          "id": 1043,
          "name": "Staging",
          "role": "staging",
          "role_label": "Staging",
          "slug": "staging"
        }
      ],
      "health": "healthy",
      "hosting": {
        "cluster_kind": "customer",
        "label": "CoreCluster Northwind UK 1"
      },
      "id": 1042,
      "kind": "corecluster",
      "limits": {
        "cpu_millicores": 2000,
        "disk_bytes": 10737418240,
        "memory_bytes": 4294967296
      },
      "logs": null,
      "mariadb": {
        "version": "11.8"
      },
      "mode": "production",
      "mode_label": "Domain attached",
      "operation": null,
      "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.northwind.cfstack.example.net",
      "primary_url": "https://harbourandfinch.example.com",
      "removed": false,
      "restore": null,
      "site": {
        "domain": "harbourandfinch.example.com",
        "id": 1042
      },
      "site_id": "rs-northwind-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
      },
      "tier": "S",
      "uat_size": null,
      "usage": {
        "cpu_millicores": 180,
        "disk_used_bytes": 2147483648,
        "memory_bytes": 912261120,
        "observed_at": "2026-11-14T09:10:00Z",
        "source": "live"
      }
    }
  ]
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT