Get what a new environment starts with
Answers what a new staging environment of the site inherits before you add it, and that HTTP authentication protects it from the start. A part that is not available for the site is answered as null. {site} is any row of the site; a site that cannot take a new environment now is refused as adding one is.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Returns
200 What the new environment starts with.
Fields of the 200 answer
The addresses and presets that reach the new environment. Null while this is not available for the site.
Fields
Always true. A new environment is protected by HTTP authentication from the start.
The keys the new environment gets. Null while this is not available for the site.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
409 | deleted | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | provisioning | The site is still being created. Try again in a few minutes. |
409 | site_unadopted | This site is not ready to be changed from the Control Panel yet. Contact support. |
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/corestack/sites/1042/environments/starts-with \
-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/corestack/sites/1042/environments/starts-with');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/environments/starts-with', {
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/corestack/sites/1042/environments/starts-with",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"firewall": {
"closed_to_others": false,
"inherited": 2,
"items": [
{
"cidr": "203.0.113.10/32",
"layer": "website",
"owner": {
"id": 1302,
"name": "harbourandfinch.example.com",
"type": "website"
},
"scope": "both"
},
{
"cidr": "198.51.100.24/32",
"layer": "company",
"owner": {
"id": 1204,
"name": "Harbour & Finch",
"type": "company"
},
"scope": "both"
}
],
"presets": [
{
"layer": "company",
"name": "GitHub Actions",
"owner": {
"id": 1204,
"name": "Harbour & Finch",
"type": "company"
},
"ranges": 1,
"slug": "github-actions"
}
],
"stage": "dark"
},
"http_auth": {
"enabled": true
},
"ssh": {
"items": [
{
"layer": "company",
"name": "Deploy key",
"owner": {
"id": 1204,
"name": "Harbour & Finch",
"type": "company"
}
}
],
"keys": 1
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "deleted",
"message": "This site is deleted. Restore it first.",
"reason": "deleted"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}