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

Get a site's error pages

Answers which errors show a page of yours or of the platform and which show the application's own answer, the pages, the version every change sends back, and the latest change.

GET/api/corestack/sites/{site}/error-pages

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 site's error pages. tags is shortened here.

Fields of the 200 answer
applied_revision_idinteger or nullRequired

The revision the site serves now.

availablebooleanRequired

Whether the site can use error pages yet.

can_changebooleanRequired

Whether you may change the pages now.

configobjectRequired

A site's error pages configuration.

Fields
codesobjectRequired

For each status code, whether a visitor gets an error page (page) or the application's own answer (app).

Fields
404stringRequired
pageapp
500stringRequired
pageapp
502stringRequired
pageapp
503stringRequired
pageapp
504stringRequired
pageapp
pagesobjectRequired

The maintenance page and the page of each code.

Fields
404objectRequired
Fields
messagestring or null

One line of plain text the page shows through the {{message}} tag, at most 300 characters. Null shows the default message.

sourcestring or null

Your own HTML for the page, at most 64 KiB (65,536 bytes), and all pages at most 256 KiB together. Null shows the platform's page.

500objectRequired
Fields
messagestring or null

One line of plain text the page shows through the {{message}} tag, at most 300 characters. Null shows the default message.

sourcestring or null

Your own HTML for the page, at most 64 KiB (65,536 bytes), and all pages at most 256 KiB together. Null shows the platform's page.

502objectRequired
Fields
messagestring or null

One line of plain text the page shows through the {{message}} tag, at most 300 characters. Null shows the default message.

sourcestring or null

Your own HTML for the page, at most 64 KiB (65,536 bytes), and all pages at most 256 KiB together. Null shows the platform's page.

503objectRequired
Fields
messagestring or null

One line of plain text the page shows through the {{message}} tag, at most 300 characters. Null shows the default message.

sourcestring or null

Your own HTML for the page, at most 64 KiB (65,536 bytes), and all pages at most 256 KiB together. Null shows the platform's page.

504objectRequired
Fields
messagestring or null

One line of plain text the page shows through the {{message}} tag, at most 300 characters. Null shows the default message.

sourcestring or null

Your own HTML for the page, at most 64 KiB (65,536 bytes), and all pages at most 256 KiB together. Null shows the platform's page.

maintenanceobjectRequired
Fields
messagestring or null

One line of plain text the page shows through the {{message}} tag, at most 300 characters. Null shows the default message.

sourcestring or null

Your own HTML for the page, at most 64 KiB (65,536 bytes), and all pages at most 256 KiB together. Null shows the platform's page.

support_emailstring or nullRequired

Shown where a page uses the {{support_email}} tag. Up to 254 characters.

limitsobjectRequired
Fields
page_bytesintegerRequired

The largest one page may be.

row_bytesintegerRequired

The largest all pages may be together.

lockedobject or any or nullRequired

Set while Corefinity has locked the site's error pages: you can read, preview and test them, and changes are refused. Null otherwise.

operationobject or any or nullRequired

The latest change. Null when there has been none.

pagesarray of objectsRequired

Each page at a glance.

Fields of each item
bytesintegerRequired
changedobject or any or nullRequired

The last revision that changed the page. Null when none has.

idstringRequired
maintenance404500502503504
statestringRequired

The platform's page, your own, or the application's own answer.

platformcustomapp
warningsintegerRequired
revisionobject or any or nullRequired

The saved revision. Null while the site is on the platform defaults.

site_idintegerRequired

At least 1.

site_namestringRequired

What the {{site_name}} tag shows.

tagsarray of objectsRequired

The tags a page may use.

Fields of each item
descriptionstringRequired
scopestring
tagstringRequired
unavailable_reasonstring or nullRequired

Why not, when available is false, such as runtime while the site waits for a platform update.

versionintegerRequired

Send it back with every change.

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/error-pages \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "applied_revision_id": 312,
  "available": true,
  "can_change": true,
  "config": {
    "codes": {
      "404": "app",
      "500": "page",
      "502": "page",
      "503": "page",
      "504": "page"
    },
    "pages": {
      "404": {
        "message": null,
        "source": null
      },
      "500": {
        "message": null,
        "source": null
      },
      "502": {
        "message": null,
        "source": null
      },
      "503": {
        "message": null,
        "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>"
      },
      "504": {
        "message": null,
        "source": null
      },
      "maintenance": {
        "message": null,
        "source": null
      }
    },
    "support_email": null
  },
  "limits": {
    "page_bytes": 65536,
    "row_bytes": 262144
  },
  "locked": null,
  "operation": {
    "can_retry": false,
    "completed_at": "2026-11-06T09:17:03Z",
    "created_at": "2026-11-06T09:16:40Z",
    "error": null,
    "id": 5119,
    "outcome": "applied",
    "status": "completed",
    "steps": [
      {
        "at": "2026-11-06T09:16:40Z",
        "detail": "No problems",
        "key": "check",
        "label": "Check",
        "state": "done"
      },
      {
        "at": "2026-11-06T09:16:41Z",
        "detail": null,
        "key": "commit",
        "label": "Commit",
        "state": "done"
      },
      {
        "at": "2026-11-06T09:16:58Z",
        "detail": null,
        "key": "apply",
        "label": "Apply",
        "state": "done"
      },
      {
        "at": "2026-11-06T09:17:03Z",
        "detail": "Checked on your site",
        "key": "verify",
        "label": "Verify",
        "state": "done"
      }
    ]
  },
  "pages": [
    {
      "bytes": 0,
      "changed": null,
      "id": "maintenance",
      "state": "platform",
      "warnings": 0
    },
    {
      "bytes": 0,
      "changed": null,
      "id": "404",
      "state": "app",
      "warnings": 0
    },
    {
      "bytes": 0,
      "changed": null,
      "id": "500",
      "state": "platform",
      "warnings": 0
    },
    {
      "bytes": 0,
      "changed": null,
      "id": "502",
      "state": "platform",
      "warnings": 0
    },
    {
      "bytes": 169,
      "changed": {
        "at": "2026-11-02T15:41:09Z",
        "by": "Eleanor Finch",
        "revision": 2
      },
      "id": "503",
      "state": "custom",
      "warnings": 0
    },
    {
      "bytes": 0,
      "changed": null,
      "id": "504",
      "state": "platform",
      "warnings": 0
    }
  ],
  "revision": {
    "author": "Eleanor Finch",
    "created_at": "2026-11-02T15:41:09Z",
    "id": 312,
    "note": "Our own 503 page",
    "number": 2,
    "origin": "save"
  },
  "site_id": 1042,
  "site_name": "harbourandfinch.example.com",
  "tags": [
    {
      "description": "The status code of this page, for example 503.",
      "scope": "compile",
      "tag": "{{status_code}}"
    },
    {
      "description": "The message you set for this page.",
      "scope": "compile",
      "tag": "{{message}}"
    }
  ],
  "unavailable_reason": null,
  "version": 2
}
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