List the environments a template reaches
Answers the environments of this platform the template reaches, 50 a page, each with what every stage does (follows the template or holds its own content), and a summary of the counts. Paged by cursor: send next_cursor back as cursor; null means the last page.
Path parameters
The id of a company you belong to or manage. Digits only. At least 1.
The platform the template is for, such as magento2, laravel or wordpress. The list answers the ones your company can have.
Query parameters
The next_cursor of the previous answer, a whole number here. Anything else is refused 422 invalid on cursor. 0 to 999999.
Only production environments, or only the others.
productionuatbuilddatabasepost_deploysettingsOnly the environments in this state.
follows_every_stageoverrides_someoverrides_every_stagereplaced_belowchanged_since_deploykeptrelink_pendingA domain or environment name to search for. Up to 100 characters.
Returns
200 A page of environments, with the summary.
Fields of the 200 answer
Fields of each item
The id of the environment's pipeline, the {binding} of the site pipeline endpoints.
The stages that changed since the environment last deployed.
Fields
productionuatFields
The company that owns the site, when it is not this one.
By stage, whether it follows the template (state), and the revision and level it follows.
Counts across every environment the template reaches, whatever the filters.
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. |
422 | invalid | Fix the field named in field; errors says why. |
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/companies/1204/deploy-templates/magento2/usage \
-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/companies/1204/deploy-templates/magento2/usage');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/companies/1204/deploy-templates/magento2/usage', {
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/companies/1204/deploy-templates/magento2/usage",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"data": [
{
"binding_id": 2210,
"changed_since_deploy": [],
"environment": {
"name": "Production",
"slug": "production"
},
"last_deployment": null,
"role": "production",
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042,
"kind": "corecluster",
"owner": null
},
"site_id": 1042,
"stages": {
"build": {
"level": "corefinity",
"revision": 2,
"state": "follows"
},
"database": {
"level": "corefinity",
"revision": 2,
"state": "follows"
},
"post_deploy": {
"level": "owner",
"revision": 2,
"state": "follows"
},
"settings": {
"level": "corefinity",
"revision": 2,
"state": "follows"
}
},
"states": [
"follows_every_stage"
]
}
],
"next_cursor": null,
"summary": {
"changed_since_deploy": 0,
"environments": 1,
"follows_every_stage": 1,
"kept": 0,
"overrides_every_stage": 0,
"overrides_some": 0,
"production": 1,
"relink_pending": 0,
"replaced_below": 0
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "invalid",
"errors": {
"name": [
"The name argument is not in the expected format."
]
},
"field": "name",
"message": "Some arguments are not valid.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}