CorefinityCorefinityDocs
Open the Control PanelControl Panel
Platform plugins · 1 of 2

Get a site's platform plugins

Answers whether the platform's own plugins run on a WordPress site, the layout found, whether you may change the setting, and what turning them off would stop.

GET/api/corestack/sites/{site}/platform-plugins

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 setting.

Fields of the 200 answer
platform_pluginsobjectRequired

A WordPress site's platform plugins: whether they run, and what turning them off would stop.

Fields
appliesbooleanRequired

True for a WordPress site. No other platform has platform plugins.

applyingbooleanRequired

True while the platform is still applying the last change.

can_changebooleanRequired

True when you may change the setting: only the site's managing agency and Corefinity can.

changed_atstring or nullRequired

When they were turned off, with a +00:00 offset rather than Z. Null while they are on. Format: date-time.

cut_overbooleanRequired

True once the site is past its go-live hold. The platform plugins can then no longer be turned off.

enabledbooleanRequired

Whether the platform plugins run. True until somebody turns them off.

keyedbooleanRequired

True for a production site whose setting is also applied by the platform as an operation; a change then answers that operation.

layoutstringRequired

The WordPress layout found on the site.

classicbedrock
layout_labelstringRequired
needs_attentionstring or nullRequired

A sentence saying what to do when the last change could not be confirmed on the site. Null otherwise.

off_notestring or nullRequired

What to know before turning them off, when a turn-off is still possible.

off_refusedstring or nullRequired

Why a turn-off would be refused, when that is already known.

off_warningstring or nullRequired

What else a turn-off ends, when a turn-off is still possible.

reasonstringRequired

The sentence those tools are refused with.

refused_functionsarray of stringsRequired

The site tools that are refused while the platform plugins are off.

runtime_readybooleanRequired

Whether the site's software can turn the platform plugins off. When false, a turn-off is refused runtime_lacks_capability.

stopsarray of stringsRequired

What stops working while the platform plugins are off, in plain words. Show this before sending confirm_off.

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.
404noneCheck the id. You see only what your account can reach.
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/platform-plugins \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "platform_plugins": {
    "applies": true,
    "applying": false,
    "can_change": true,
    "changed_at": null,
    "cut_over": false,
    "enabled": true,
    "keyed": true,
    "layout": "classic",
    "layout_label": "Standard WordPress",
    "needs_attention": null,
    "off_note": "Turning them off is refused once the site is past its go-live hold; the site gives the final answer when you confirm.",
    "off_refused": null,
    "off_warning": "Turning them off also ends the go-live hold: email, outgoing requests, payment gateways and Action Scheduler tasks are no longer held back. This takes effect up to about a minute after the platform applies the change, and turning them back on brings the hold back the same way.",
    "reason": "Needs the platform plugin, which is turned off for this site.",
    "refused_functions": [
      "wp_login_link"
    ],
    "runtime_ready": true,
    "stops": [
      "One-click login to wp-admin from the Control Panel",
      "Viewing the site on its platform address: WordPress sends visitors to its own address instead",
      "Before go-live: email, payments and outgoing requests are no longer held back",
      "Before go-live: the platform address is no longer kept out of caches",
      "The Control Panel's From address for email sent with PHP mail",
      "On a preview environment: email from SMTP plugins is no longer caught, and known live integrations are no longer blocked"
    ]
  }
}
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