Get a site's Node.js configuration
Answers the site's Node.js: the version it runs, the versions it may move to, the global packages, follow mode, the caches and any change still running. revision is the write token every change sends back. refresh=1 reads the site's report again first, which runs a command on the site; only that read counts on the live budget of 10 a minute, shared with the package check and the cache clear, and a spent budget answers 429.
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.
Query parameters
Send 1 to read the running site's report again before answering.
10truefalseReturns
200 The Node.js configuration.
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.
The Node.js change still running, what the site refused in the last one, and a change waiting for the window.
Fields
The window_date and item_id of a change that waits for the site's window.
The size of each package cache (npm_bytes, corepack_bytes, pnpm_bytes, yarn_bytes) and when it was measured. Null until the site has reported them.
True when each deployment switches to the version the repository asks for.
Format: date-time.
Fields
Set when Corefinity has locked the site's Node.js configuration, with the reason. Null otherwise.
The Node.js version the site is set to.
The memory of the site's command line (cli_limit_bytes) and Node.js's heap (heap_mib). Null until the site has reported them.
The versions the site may move to.
Fields of each item
What brings the version to the site when it is not there yet. Null when it is.
Whether the site, or a new site, has this version to hand.
What acknowledge must carry to choose it, such as eol.
Why it cannot be chosen, when it cannot.
Whether it can be chosen.
Such as active_lts, maintenance_lts or end_of_life.
Fields of each item
The security advisories of the last check, by severity.
Fields
The commands the installed package provides.
What went wrong when the package failed to install (message, tail). Null otherwise.
Null when the registry has not been asked.
The newest version on the registry at the last check, which may be outside the selector.
Where the line comes from. panel for one saved here or in the Control Panel.
The version the selector is pinned to.
Whether the package's install scripts run.
The version, range or tag asked for.
installed, installing, failed or pending.
The newest version within the selector at the last check.
What the repository asks for (source, raw, majors, satisfied, read_at), when it has been read. Null otherwise.
The write token. Send it back with every change; a change made since your read is refused stale.
The lifecycle of the site's version (key, label, end_of_life_on).
Global packages found on the site that were installed by hand, by name.
The full version the site reports, when it has reported one.
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 | string | string. |
429 | rate_limited | Wait for the seconds in Retry-After. |
503 | connect_failed | The cluster could not be reached. |
503 | temporarily_unavailable | The Control Panel could not answer just now. Nothing was started; try again shortly. |
503 | switched_off | Corefinity has switched this action off for the moment. Try again later. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/sites/1042/node-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/node-runtime');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/node-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/node-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"
},
"apply": {
"error": null,
"operation": null,
"pending_tonight": null
},
"caches": null,
"follow_repository": false,
"last_applied_at": null,
"limits": {
"max_packages": 20
},
"locked": null,
"major": 24,
"memory": null,
"options": [
{
"arrives_with": null,
"available_on_this_row": true,
"codename": "Krypton",
"default_for_new": true,
"end_of_life_on": "2028-04-30",
"label": "Node.js 24",
"major": 24,
"needs_ack": [],
"reason": null,
"recommended": true,
"selectable": true,
"status": "maintenance_lts"
},
{
"arrives_with": null,
"available_on_this_row": true,
"codename": "Jod",
"default_for_new": false,
"end_of_life_on": "2027-04-30",
"label": "Node.js 22",
"major": 22,
"needs_ack": [],
"reason": null,
"recommended": false,
"selectable": true,
"status": "maintenance_lts"
},
{
"arrives_with": null,
"available_on_this_row": true,
"codename": "Hydrogen",
"default_for_new": false,
"end_of_life_on": "2025-04-30",
"label": "Node.js 18",
"major": 18,
"needs_ack": [
"eol"
],
"reason": null,
"recommended": false,
"selectable": true,
"status": "end_of_life"
}
],
"packages": [
{
"advisories": {
"critical": 0,
"high": 0
},
"bins": [],
"error": null,
"has_install_script": null,
"installed_version": null,
"latest": null,
"name": "sass",
"origin": "panel",
"resolved": "1.93.2",
"scripts": false,
"selector": "latest",
"state": "pending",
"update_available": false,
"wanted": null
},
{
"advisories": {
"critical": 0,
"high": 0
},
"bins": [],
"error": null,
"has_install_script": null,
"installed_version": null,
"latest": null,
"name": "sharp",
"origin": "panel",
"resolved": "0.34.4",
"scripts": true,
"selector": "0.34",
"state": "pending",
"update_available": false,
"wanted": null
}
],
"repository": null,
"revision": 4,
"status": {
"end_of_life_on": "2028-04-30",
"key": "maintenance_lts",
"label": "Maintenance LTS"
},
"unmanaged": [],
"version": null
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "string",
"detail_reason": "string",
"message": "string",
"reason": "string"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"code": "connect_failed",
"message": "The cluster could not be reached",
"reason": "connect_failed"
}