CorefinityCorefinityDocs
Open the Control PanelControl Panel
Error pages · 5 of 12

Preview an error page

Answers the page as visitors would get it, with the tags filled in from sample values and everything a page may not contain removed. Nothing is saved.

POST/api/corestack/sites/{site}/error-pages/preview

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.

Body

messagestring or null

The message for the {{message}} tag, in place of the saved one. One line of plain text, at most 300 characters. Left out or null, the default message is used.

pagestringRequired
maintenance404500502503504
sampleobject

Values to show in place of the samples, for these four only. The other tags (status_code, status_text, message, site_name, retry_after) cannot be set here, and any other key is refused invalid.

Fields
hoststring or null

The value of the {{host}} tag.

request_idstring or null

The value of the {{request_id}} tag.

support_emailstring or null

An unsaved support email for the {{support_email}} tag, checked as a save checks it. Null shows none. Up to 254 characters.

time_utcstring or null

The value of the {{time_utc}} tag.

sourcestring or null

The page's HTML, at most 64 KiB (65,536 bytes; a longer one answers 413 too_large). Left out or null, the platform's page is used.

Returns

200 The page and what the check found.

Fields of the 200 answer
bytesintegerRequired

The size of the page as it would be saved.

diagnosticsarray of objectsRequired
Fields of each item
codestringRequired
columninteger or null
lineinteger or null
messagestringRequired
pagestring
severitystringRequired

error stops a save; warning does not.

samplesobjectRequired

The value used for each tag.

htmlstringRequired

The page as visitors would get it.

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.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
413too_largeThe upload is larger than the limit for one file.
422invalidFix the field named in field; errors says why.
429rate_limitedWait 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/preview \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Back at 10:00 UTC",
    "page": "503",
    "source": "<!DOCTYPE html><html><head><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>{{message}}</p></body></html>"
  }'
{
  "bytes": 249,
  "diagnostics": [],
  "html": "<!DOCTYPE html><html><head>\n<meta name=\"robots\" content=\"noindex\"><meta name=\"viewport\" content=\"width=device-width\"><title>Back soon</title></head><body><h1>Back soon</h1><p>Back at 10:00 UTC</p></body></html>",
  "samples": {
    "host": "www.harbourandfinch.example.com",
    "message": "Back at 10:00 UTC",
    "request_id": "4f2c9a1e7b3d4c5a8e6f0b1a2c3d4e5f",
    "retry_after": "300",
    "site_name": "harbourandfinch.example.com",
    "status_code": "503",
    "status_text": "Down for maintenance",
    "support_email": "",
    "time_utc": "2026-11-24T09:30:00+00:00"
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

This sends a real POST request and changes your account.

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

Was this helpful?
Open in ClaudeOpen in ChatGPT