Test the error pages on the site
Runs a check against the site that changes none of its pages. live asks one of the site's own addresses for a path, as a visitor would, and answers the status, the main headers and who drew the answer; render answers which version of each page the site serves now (while maintenance is on, only the maintenance page). The first render on a site that has never been checked prepares the site instead, which takes a person who may change the site (anyone else is answered 404): the answer then has preparing: true, no pages and the operation_id of the preparation. Follow that id with the general operation endpoint (GET /) until its status is completed, then send the request again. The error pages operation endpoint answers changes to the pages only, so it answers 404 for a preparation.
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.
Body
liverenderFor live: the path to ask for, with its query string if any. It starts with a single / and has no spaces, control characters or # fragment. Defaults to /. Up to 512 characters.
Returns
200 The check's result. pages is shortened here.
Fields of the 200 answer
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 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | operation_in_progress | A change to the environment is in progress. Try again when it has finished. |
409 | restore_running | A restore is running on the site. Wait for it to finish, then try again. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/error-pages/test \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"kind": "live",
"path": "/"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/error-pages/test', [
'kind' => 'live',
'path' => '/',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/error-pages/test', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
kind: 'live',
path: '/',
}),
});
// 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.post(
"https://manage.corefinity.com/api/corestack/sites/1042/error-pages/test",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"kind": "live",
"path": "/",
},
)
data = res.json() if res.content else None{
"body_head": "<!doctype html><html lang=\"en\"><head><title>Harbour & Finch</title>",
"bytes": 5120,
"checked_at": "2026-11-06T09:16:40Z",
"error": null,
"headers": {
"cache-control": null,
"cf-cache-status": null,
"content-type": "text/html; charset=UTF-8",
"retry-after": null,
"server": "nginx"
},
"kind": "live",
"message": null,
"refused": null,
"status": 200,
"truncated": true,
"url": "https://harbourandfinch.example.com/",
"who": "app"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "managed_elsewhere",
"message": "This site is managed by another control panel",
"reason": "managed_elsewhere"
}{
"code": "invalid",
"errors": {
"kind": [
"kind is live or render."
]
},
"field": "kind",
"message": "kind is live or render.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many attempts on this environment. Try again shortly.",
"reason": "rate_limited",
"retry_after_seconds": 60
}