Browse all docs

Status page

Status page: a public page showing component status, uptime, incidents and maintenance notices to your customers, plus a platform status JSON.

What it does

The status page is a public web page. Visitors need no login to see whether your service is healthy now, its past uptime, and the incidents and maintenance notices you publish. The page shows no node IPs, hostnames or node counts.

When to use it

  • Tell customers the scope and progress when a line is unstable.
  • Announce maintenance windows in advance.
  • Reflect a line's health automatically from the share of available nodes in a line group.

Where to configure it

In the console: System, Status page. Two tabs: "Page and components" and "Incidents and maintenance". The public address is shown at the top of the page, can be opened or copied, and the path is /status/.

Settings

Page and components

SettingDescription
Public status pageSwitch; when off, visitors see "Status page is not enabled"
Page titleDefaults to "Service status" when empty
Page descriptionShown under the title
Show brand logoSwitch
ComponentsUp to 50, sortable; names are 1 to 64 characters and must be unique

Component properties:

PropertyDescription
Name, descriptionShown to visitors
Status source"Manual" or "Line group"
Line groupChosen when the source is a line group; status is computed from the share of available nodes in it
Manual statusOperational, degraded, outage, under maintenance

A component's current status is the most severe of its automatic status, manual status, the impact of unresolved incidents and any active maintenance window. Deleting a component also deletes its uptime history.

Incidents and maintenance

TypeStatus flow
IncidentInvestigating, identified, monitoring, resolved
MaintenanceScheduled, in progress, completed

Publishing an incident needs a title, an impact (degraded or outage), the affected components and a progress message; scheduling maintenance also needs a start and end time. You can then "Post update", and every update is shown to visitors. A closed incident cannot be updated; one published by mistake can be deleted. The public page shows incidents and maintenance from the last 14 days.

Platform status

The "Platform status" page in the licensing operator console maintains the platform's own components (up to 20, add, remove and reorder), incidents and maintenance, and exposes them as public JSON that websites can read:

GET /public/v1/platform-status

FAQ

Visitors open /status/ and see "Status page is not enabled"

Turn on "Public status page" under "Page and components".

What does the automatic status show

Of the enabled endpoints in the line group, the share that is healthy. An endpoint counts as available when it is healthy, or when it has no probe data and its node is online and active.

Can I maintain it by hand only

Yes. Set the status source to "Manual" and change the status yourself.

What permission is needed

Viewing needs the system configuration read permission; changing needs the system configuration manage permission.