Get Public Status Page
Two endpoints serve the public status page view:
GET /api/status-pages/public/:slug: lookup by URL slugGET /api/status-pages/public/by-id/:id: lookup by numeric ID
No authentication required for visibility: public pages. Customer-member authentication required for visibility: customer_members_only pages. A customer_members_only page without a customer is open to every logged-in member of its organization.
Pages with visibility: sso_members_only work like customer_members_only and additionally require a session created through the organization's single sign-on: not signed in, or signed in without SSO, both endpoints answer 401 ssoRequired.
Pages with visibility: password_protected need the page password: without a valid access cookie both endpoints answer 401 passwordRequired. The visitor unlocks the page with:
POST /api/status-pages/public/:slug/verify-password
{ "password": "the page password" }The answer is { "ok": true } and sets the httpOnly cookie sp_access_<page id> (path /, valid for 30 days, SameSite=Lax, Secure). Send it with later requests to both endpoints. A new password set with Update Status Page invalidates every cookie issued before. The check allows 10 attempts per minute per IP address and page; beyond that it answers 429 with data.retryAfter. Errors: 400 passwordRequired (empty or missing password), 401 invalidPassword (wrong password), 404 statusPageNotFound (no published page with this slug, or the page is not password protected).
A page with an IP allowlist (ipAllowlist) answers 403 statusPageIpNotAllowed to visitors from other networks, whatever its visibility. This applies to both lookups and to the password check of a protected page (verify-password), which then does not check the password at all. The address that counts is the one our reverse proxy sees, not an X-Forwarded-For header sent by the client.
With audience groups (audienceGroups), components leaves out the components of groups the visitor does not belong to (signed in with a verified email address of one of the group's domains; admins and editors of the page see everything), together with incidents and maintenance that only affect them; overallStatus and overallState are computed from what the visitor sees. Responses for a page with an IP allowlist or audience groups carry Cache-Control: private, no-store.
Badge (/status/:slug/badge.svg), embed widget (/status/:slug/embed), Atom/RSS feeds and subscriptions exist only for pages with visibility: public and neither IP allowlist nor audience groups; for every other page they answer 404 like a missing page.
Preview of an unpublished page. GET /api/status-pages/public/:slug also answers for a page with isPublished: false when the request is signed in as a member of the page's own organization with access to the design editor (admin, editor or readonly) and, for a page with a customer, that customer in scope. The response is the same, with isPublished: false and Cache-Control: private, no-store; the public page shows a "Preview, not public" banner. Everyone else, including members of other organizations and anonymous visitors, gets 404 statusPageNotFound. The lookup by ID, the badge, the widget, the feeds and custom domains serve published pages only.
Response
{
"statusPage": {
"id": 1,
"name": "Production Status",
"slug": "production-status",
"description": "Real-time status of our production services",
"visibility": "public",
"isPublished": true,
"showRecentIncidents": true,
"showRecentMaintenance": true,
"overallState": "degraded",
"overallStatus": "partial_outage",
"smsSubscriptionsEnabled": true,
"pushPublicKey": "BOr3...base64url...",
"productName": "Northwind Monitoring",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
},
"websites": [
{
"id": 101,
"name": "Main Site",
"url": null,
"status": "active",
"state": "operational",
"publicStatus": "operational",
"inMaintenance": false,
"openIncidents": 0,
"lastCheckedAt": "2026-05-01T12:00:00.000Z"
}
],
"components": {
"groups": [
{
"id": 3,
"name": "Core services",
"collapsed": false,
"components": [
{
"id": 7,
"name": "Main Site",
"description": null,
"sourceKind": "monitor",
"monitorType": "http",
"monitorId": 101,
"manualStatus": null,
"dependency": null,
"state": "operational",
"publicStatus": "operational",
"showUptime": true,
"uptimeDays": [],
"availability": null
}
]
}
],
"ungrouped": [
{
"id": 8,
"name": "Payment provider",
"description": "Card payments at checkout",
"sourceKind": "manual",
"monitorType": null,
"monitorId": null,
"manualStatus": "partial_outage",
"dependency": null,
"state": "degraded",
"publicStatus": "partial_outage",
"showUptime": true,
"uptimeDays": [],
"availability": null
}
]
},
"maintenanceHistory": [],
"scheduledMaintenances": [],
"incidentHistory": [
{
"id": 5121,
"websiteId": 0,
"websiteName": "Card payments failing",
"type": "manual",
"status": "open",
"startedAt": "2026-10-27T09:12:00.000Z",
"resolvedAt": null,
"title": "Card payments failing",
"severity": "major",
"source": "manual",
"updates": [
{
"status": "investigating",
"body": "We are looking into failed card payments.",
"createdAt": "2026-10-27T09:13:00.000Z",
"authorName": "Pascal H."
}
],
"affectedComponents": [
{ "id": 8, "name": "Payment provider", "impact": "partial_outage" }
],
"postmortem": null
}
]
}state values: operational, warning (SSL-only incidents), degraded (non-SSL incidents), maintenance (active maintenance window).
publicStatus (since 27 October 2026, on every website and component) separates what state lumps together, in the vocabulary of manualStatus and of the common status page vendors:
publicStatus | Monitor | state |
|---|---|---|
operational | no open incident | operational |
maintenance | inside a maintenance window, no open incident | maintenance |
degraded | certificate notice only (ssl_warning, ssl_expiry) | warning |
partial_outage | answers, but another check fails (response time, keyword, page size, redirect, DNSBL) | degraded |
major_outage | down or answering with an error status (downtime, http_status, ssl_handshake) | degraded |
state is the projection of publicStatus shown in the last column and keeps its meaning; new integrations should read publicStatus and overallStatus.
smsSubscriptionsEnabled is true when the page offers SMS subscriptions, the platform can send SMS and the organization has SMS quota. pushPublicKey is the VAPID public key (base64url) to pass to PushManager.subscribe as applicationServerKey when the page offers browser push, otherwise null. See Subscribe to a Status Page.
overallStatus is the most severe publicStatus across all monitors on the page and all manual and dependency components, with one exception: major_outage only when every one of them is down; a major outage of some next to working ones reads partial_outage. An open incident linked page-wide counts as stated. An override set through Incident Management wins over it (warning = degraded, degraded = major_outage). overallState is the projection of overallStatus and, as before, the most severe state.
websites lists every monitor on the page: the monitor components plus, with includeCustomerMonitors, the customer's monitors except the hidden ones. components lists only the explicit components, in sort order: groups with their components, then ungrouped. The automatically included customer monitors are not repeated there.
- A monitor component carries the state of its monitor. It is left out while the page does not show that monitor.
- A manual component carries its
manualStatusaspublicStatus, mapped tostate:operationaltooperational,maintenancetomaintenance,degradedtowarning,partial_outageandmajor_outagetodegraded. - A manual component carries its
manualStatusraised by the worst open incident linked to it (status_page_incident_link, or an Incident Management statuspage rule withcomponentIds). The incident'simpactuses the same mapping. Resolving the incident brings the component back to itsmanualStatus. - A dependency component (
sourceKind: dependency) carriesdependency(slug,name,status) with the overall status we publish for that provider.statusis mapped likemanualStatus;unknown(we cannot see the provider) becomespublicStatusdegraded(statewarning) and does not count towardsoverallStatus/overallState. A linked open incident raises it like a manual component. It has nouptimeDays. uptimeDaysandavailabilityare filled in every layout (since 27 October 2026; before only on Statusboard): onwebsitesalways, on monitor components withshowUptime.- Manual components with
showUptimehaveuptimeDaysandavailabilitytoo (since 28 October 2026), computed from the incidents linked to them, including backfilled ones (Backfill Incident): an incident with impactpartial_outageormajor_outagecounts as downtime from its start to its end on the pages;degradedandmaintenancedo not. The bar starts when the component was created, or earlier with an older linked incident. - Without booked monitoring (the trial ended or monitoring was cancelled; status pages stay free and online) monitors have no live state: monitor components and
websitesentries reportstateandpublicStatusasoperational(and so doesoverallStatusunless something else lifts it), raised only by a linked open incident like a manual component, with emptyuptimeDays,availability: nullandshowUptime: false. Monitor incidents are no longer listed. Once monitoring is booked again, the monitor state applies again. GET /api/status-pages/public/by-id/:idonly knows websites: it leaves out monitor components of other monitor kinds.
Incidents and maintenance (every layout)
Since 27 October 2026 the endpoint returns incidents, their update threads and maintenance windows for every layout, not only Statusboard, and also for a page without a single monitor. incidentHistory is newest first, cut at the design's incidentLimit; open incidents are always included, resolved ones within incidentDays.
source | Which incidents |
|---|---|
monitor | Incidents of a monitor on the page. |
manual | Manual incidents linked to this page (POST /api/incidents with statusPageIds), and manual incidents of the page's customer. |
im | Incident Management incidents a statuspage rule of this page matches (team and severity) and that have at least one public update. Without an update the incident is not listed, but the rule's components still show its target state. id is the Incident Management id; updates is the public timeline from POST /api/im/incidents/:id/statuspage-update; severity is critical (sev1), major (sev2) or minor. Team, responders and internal notes are never part of the response. |
affectedComponents names the components of this page an incident affects, with its impact (degraded, partial_outage, major_outage, maintenance). An open manual incident linked page-wide (no component) raises overallStatus by its impact; a manual incident of the customer without a link raises it by its severity (minor = degraded, major = partial_outage, critical = major_outage).
postmortem (since 28 October 2026) is the published postmortem of an incident, { body, publishedAt } with body in Markdown, or null. The layouts render it below the incident as an expandable section, without raw HTML. See Publish Postmortem.
maintenanceHistory contains every active window that covers a website on the page: windows on the website itself, on several targets, on a tag (also organization-wide) and on the whole customer. websiteId/websiteName name a website of the page the window covers.
scheduledMaintenances lists the scheduled maintenance of the page itself (see Schedule Status Page Maintenance), newest start first: id, title, description, scheduledFor, scheduledUntil, state (scheduled, in_progress, completed), affectedComponents (id, name; empty = the whole page) and updates (body, createdAt, oldest first). Upcoming maintenance is listed without limit, completed maintenance within maintenanceDays, cancelled maintenance never; the list is empty while the design hides maintenance. While a maintenance is in_progress, its components carry publicStatus: maintenance (a worse state stays) and a maintenance without components sets overallStatus to at least maintenance, whatever the design shows.
Incident history (historyPage)
GET /api/status-pages/public/:slug?historyPage=1 returns the incident history the way the public page shows it under Incident history (/status/:slug?history=1, or ?history=1 on a custom domain). The history has no end in the past: page 1 is the current calendar month and the two before it, page 2 the three months before that, and so on (months in UTC). With historyPage, incidentHistory lists every incident that started in that window, open or resolved, at most 200, newest first, whatever incidentDays and incidentLimit say; everything else in the response (state, components, bars, maintenance) stays the same. The uptime bars keep their limit of 90 days.
The response then carries history:
{
"history": {
"page": 2,
"from": "2026-05-01T00:00:00.000Z",
"to": "2026-08-01T00:00:00.000Z",
"hasOlder": true
}
}from is inclusive, to exclusive; hasOlder tells whether older incidents exist (page 3). historyPage is an integer from 1 to 400; anything else answers 400 invalidRequestBody. While the design hides incidents (showIncidents: false) the list is empty and hasOlder is false.
GET /api/status-pages/public/by-id/:id returns manual and linked incidents as well, without source, updates, affectedComponents and postmortem, and no Incident Management incidents.
statusPage.designConfig.statusLabels holds the page's own texts per state (see Update Status Page Design); a state without one shows the default text. The page, the badge and the widget use them.
productName is your organization's white-label product name, or null when you have not set one (or have hidden it). It is what the page's own footer uses for the "Powered by" line.
url is null unless the page's design has Show service URLs switched on (designConfig.showServiceUrls: true). Before 4 September 2026 the field was always filled and only the rendered page hid it; for non-HTTP monitors it carried the raw hostname of a mail, SSH or FTP server. The design toggle is now enforced by the server.
incidentHistory[].updates[].authorName is the author's first name plus the initial of their last name, e.g. "Pascal H.", never the full name.
This response no longer contains organizationId or customerId. They were internal row identifiers that this public endpoint served to every visitor of every published page; nothing in the rendered page used them. If you were reading them, identify the page by id or slug instead, both are still returned.
Common errors
400 Bad Request(invalidRequestBody) whenhistoryPageis not an integer from 1 to 400404 Not found(statusPageNotFound) when the status page does not exist, is not published (except the preview described above), or its organization is suspended (payment block or locked by us; an organization whose monitoring merely ended stays online), deleted or has the status pages module switched off403 Forbiddenforcustomer_members_onlypages when the user is not a member401 Unauthorized(passwordRequired) forpassword_protectedpages without a valid access cookie (see verify-password above)401 Unauthorized(ssoRequired) forsso_members_onlypages when the visitor is not signed in, or signed in without the organization's single sign-on403 Forbidden(statusPageIpNotAllowed) when the page has an IP allowlist and the request comes from another network