Get a website's environment
Answers one environment of a website. An environment of another website is not found.
Path parameters
The id of a CoreStack Enterprise website. Not the same number as a site row id. At least 1.
The id of a CoreStack Enterprise environment. Not the same number as a site row id. At least 1.
Returns
200 The environment.
Fields of the 200 answer
An environment of a website. Ids are sent as strings of digits, such as "1311".
Fields
The server to connect to for shell access, when the environment has one.
The application the environment runs.
Fields
The id of the application the environment runs.
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.
The name of type, 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 | 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/1311 \
-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/1311');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/websites/1310/environments/1311', {
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/1311",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"environment": {
"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
}