CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 18 of 18

Get a website with its environments

Answers one website with every environment: a website of your own company, or one with a CoreStack site you can open that belongs to another company, such as a client's site your company manages as its agency. Any other website answers 404. Answered with Cache-Control: no-store.

GET/api/corestack/websites/{website}

Path parameters

websiteintegerRequired

The id of a website of any product, from the websites list. Not the same number as a site row id. Digits only. At least 1.

Returns

200 The website.

Fields of the 200 answer
attentionintegerRequired

How many things on the website need attention.

badgeobjectRequired

The product the website runs on.

Fields
kindstringRequired
enterprisecorestackcoreclustermixed
labelstringRequired
clusterobject or any or nullRequired

The cluster the website is in. Null for a website that is in none.

companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
environment_countintegerRequired
environmentsarray of objectsRequired
Fields of each item
groupstringRequired

Where the environment is listed, such as production or staging.

hosting_kindstringRequired

corestack for a row /corestack/sites/{site} takes, enterprise for a CoreStack Enterprise environment.

corestackenterprise
hrefstring or nullRequired

Where the environment opens in the Control Panel.

idintegerRequired

The environment's id. Not a site row id. At least 1.

labelstringRequired
namestringRequired
pending_changesintegerRequired

How many changes wait for the maintenance window.

reseller_site_idinteger or nullRequired

The site row id to use in /corestack/sites/{site}. Null for a CoreStack Enterprise environment. At least 1.

rolestring or nullRequired
statestringRequired

Such as ready, provisioning or unknown.

uat_sizestring or null

The staging size of a CoreStack site's environment. Left out for a production row.

hrefsobjectRequired
Fields
openstring or nullRequired

Where the website opens in the Control Panel.

idintegerRequired

At least 1.

namestringRequired
pending_changesintegerRequired
platformobject or any or nullRequired

The platform of the website's production environment. Null when it has none.

regionobject or any or nullRequired

The region the website is in, when known.

statusobjectRequired
Fields
keyintegerRequired

0 inactive, 1 pending setup, 2 onboarding, 3 active.

0123
labelstringRequired
updated_atstring or nullRequired

Format: date-time.

urlstring or nullRequired

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.
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/websites/1302 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "attention": 2,
  "badge": {
    "kind": "corecluster",
    "label": "CoreCluster"
  },
  "cluster": {
    "href": "https://manage.corefinity.com/managed-clusters/clusters/17",
    "id": 1017,
    "kind": "customer",
    "label": "Northwind UK 1"
  },
  "company": {
    "id": 1204,
    "name": "Harbour & Finch"
  },
  "environment_count": 2,
  "environments": [
    {
      "group": "production",
      "hosting_kind": "corestack",
      "href": "https://manage.corefinity.com/managed-clusters/sites/1042",
      "id": 3110,
      "label": "Production",
      "name": "Production",
      "pending_changes": 0,
      "reseller_site_id": 1042,
      "role": "production",
      "state": "ready"
    },
    {
      "group": "staging",
      "hosting_kind": "corestack",
      "href": "https://manage.corefinity.com/managed-clusters/sites/1043",
      "id": 3111,
      "label": "Staging",
      "name": "Staging",
      "pending_changes": 0,
      "reseller_site_id": 1043,
      "role": "staging",
      "state": "ready",
      "uat_size": null
    }
  ],
  "hrefs": {
    "open": "https://manage.corefinity.com/managed-clusters/sites/1042"
  },
  "id": 1302,
  "name": "harbourandfinch.example.com",
  "pending_changes": 0,
  "platform": {
    "key": "wordpress",
    "label": "WordPress"
  },
  "region": null,
  "status": {
    "key": 3,
    "label": "Active"
  },
  "updated_at": "2026-11-10T00:59:44Z",
  "url": "https://harbourandfinch-example-com.northwind.cfstack.example.net"
}
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