Get a site's runtime
Answers whether the site is on the runtime, the versions it runs, the last change of each part, anything waiting for the site's window and whether the site can move onto the runtime.
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 The runtime summary.
Fields of the 200 answer
Whether a site is on the runtime, and whether it can move onto it.
Fields
Why the site cannot move at once, when it cannot.
True when the site is on the runtime.
The date Corefinity plans to move the site, if one is set.
The date of the window the move is queued for, if it is queued.
The runtime revision the site is on, such as v1. Null until it is on the runtime.
True once sites of this kind can be moved onto the runtime.
For php, nginx and node, whether a change applies without waiting for a window.
The versions the site runs.
Fields
The nginx version and revision.
The Node.js toolchain revision, the major in use and its status.
The PHP minor and patch version, the round of its build, whether that is the current one and the latest_round.
For php, nginx and node, the last change (state, at, reason), or null before the first.
Whether New Relic is set up on the runtime for this site (state, app).
What waits for the site's window.
Fields of each item
At least 1.
The date of the window a move onto the runtime is queued for.
The site's Varnish. Sent only for a Magento 2 site, while Varnish is on for your company.
True when changes to this site's cluster are made only in its window.
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. |
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/runtime \
-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/runtime');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/runtime', {
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/runtime",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"adopted": true,
"adoption": {
"adopt_now_refusal": null,
"adopted": true,
"can_adopt_now": false,
"can_adopt_tonight": false,
"in_progress": false,
"planned_for": null,
"queued_for": null,
"revision": "v1"
},
"handover": false,
"hot_apply": {
"nginx": true,
"node": true,
"php": true
},
"images": {
"nginx": {
"revision": null,
"version": null
},
"node_toolchain": {
"major": null,
"revision": null,
"status": null
},
"php": {
"current": true,
"latest_round": 1,
"minor": "8.4",
"patch": "8.4.9",
"round": 1,
"superseded_since": null
}
},
"last_apply": {
"nginx": null,
"node": null,
"php": null
},
"new_relic": {
"app": null,
"state": "none"
},
"pending": [],
"queued_for": null,
"revision": "v1",
"window_only": true
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}