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.
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 setting.
Fields of the 200 answer
A WordPress site's platform plugins: whether they run, and what turning them off would stop.
Fields
True for a WordPress site. No other platform has platform plugins.
True while the platform is still applying the last change.
True when you may change the setting: only the site's managing agency and Corefinity can.
When they were turned off, with a +00:00 offset rather than Z. Null while they are on. Format: date-time.
True once the site is past its go-live hold. The platform plugins can then no longer be turned off.
Whether the platform plugins run. True until somebody turns them off.
True for a production site whose setting is also applied by the platform as an operation; a change then answers that operation.
The WordPress layout found on the site.
classicbedrockA sentence saying what to do when the last change could not be confirmed on the site. Null otherwise.
What to know before turning them off, when a turn-off is still possible.
Why a turn-off would be refused, when that is already known.
What else a turn-off ends, when a turn-off is still possible.
The sentence those tools are refused with.
The site tools that are refused while the platform plugins are off.
Whether the site's software can turn the platform plugins off. When false, a turn-off is refused runtime_lacks_capability.
What stops working while the platform plugins are off, in plain words. Show this before sending confirm_off.
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 | none | Check the id. You see only what your account can reach. |
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/platform-plugins \
-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/platform-plugins');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/platform-plugins', {
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/platform-plugins",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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"
]
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}