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
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | none | Check the id. You see only what your account can reach. |
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/websites/1310/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/websites/1310/environments');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/websites/1310/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/websites/1310/environments",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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"
}
]
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"message": "Not found."
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?