CorefinityCorefinityDocs
Open the Control PanelControl Panel
Websites and environments · 6 of 7

List a website's environments

Answers the environments of one website.

GET/api/websites/{website}/environments

Path parameters

websiteintegerRequired

The id of a CoreStack Enterprise website. Not the same number as a site row id. At least 1.

Returns

200 The environments.

Fields of the 200 answer
environmentsarray of objectsRequired
Fields of each item
access_serverstring or nullRequired

The server to connect to for shell access, when the environment has one.

idstringRequired
namestring or nullRequired
platformobject

The application the environment runs.

Fields
idstring
namestring
slugstring
platform_idstringRequired

The id of the application the environment runs.

typeinteger or nullRequired

The kind of environment as a number: 1 development, 2 staging, 3 pre-production, 4 production, 5 project, 6 release, 7 to 11 UAT 1 to 5, 12 a development box.

type_descriptionstring or nullRequired

The name of type, such as Production or Staging.

urlstring or nullRequired
website_idstringRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404noneCheck the id. You see only what your account can reach.
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/websites/1310/environments \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "environments": [
    {
      "access_server": null,
      "id": "1311",
      "name": "Production",
      "platform": {
        "id": "1",
        "name": "Magento 2",
        "slug": "magento2"
      },
      "platform_id": "1",
      "type": 4,
      "type_description": "Production",
      "url": "https://trade.harbourandfinch.example.com",
      "website_id": "1310"
    }
  ]
}
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