CorefinityCorefinityDocs
Open the Control PanelControl Panel
PHP · 10 of 11

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.

GET/api/corestack/sites/{site}/runtime

Path parameters

siteintegerRequired

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
adoptedbooleanRequired
adoptionobjectRequired

Whether a site is on the runtime, and whether it can move onto it.

Fields
adopt_now_refusalstring or nullRequired

Why the site cannot move at once, when it cannot.

adoptedbooleanRequired

True when the site is on the runtime.

can_adopt_nowbooleanRequired
can_adopt_tonightbooleanRequired
in_progressbooleanRequired
planned_forstring or nullRequired

The date Corefinity plans to move the site, if one is set.

queued_forstring or nullRequired

The date of the window the move is queued for, if it is queued.

revisionstring or nullRequired

The runtime revision the site is on, such as v1. Null until it is on the runtime.

handoverboolean

True once sites of this kind can be moved onto the runtime.

hot_applyobjectRequired

For php, nginx and node, whether a change applies without waiting for a window.

imagesobjectRequired

The versions the site runs.

Fields
nginxobject

The nginx version and revision.

node_toolchainobject

The Node.js toolchain revision, the major in use and its status.

phpobject

The PHP minor and patch version, the round of its build, whether that is the current one and the latest_round.

last_applyobjectRequired

For php, nginx and node, the last change (state, at, reason), or null before the first.

new_relicobject

Whether New Relic is set up on the runtime for this site (state, app).

pendingarray of objectsRequired

What waits for the site's window.

Fields of each item
idintegerRequired

At least 1.

kindstringRequired
labelstring or nullRequired
statestringRequired
window_datestring or nullRequired
queued_forstring or nullRequired

The date of the window a move onto the runtime is queued for.

revisionstring or nullRequired
varnishobject

The site's Varnish. Sent only for a Magento 2 site, while Varnish is on for your company.

window_onlyboolean

True when changes to this site's cluster are made only in its window.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
429rate_limitedWait 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"
{
  "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
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT