Status pages

A status page shows your users the state of what they depend on. It is published to the edge, so it stays up when your own servers are the thing that is down.

Components

A page is a list of components, such as “API” or “Dashboard”. Give each component the monitor or heartbeat behind it and it follows that check: operational while it is up, degraded or down with it. Or give a component a status you set by hand instead of a check.

Each component carries its daily history, so visitors see how the last weeks went, not only this minute.

Incidents and maintenance

Post an incident when something is wrong: a title, an impact (none, minor, major or critical), the components it touches and an update. Add updates as you learn more and resolve it when it is over.

Schedule maintenance ahead of time with a start and an end. During the window the components show maintenance instead of down, and the page says what is planned.

Resolved incidents and finished maintenance stay on the page for a while, then drop off.

Password-protected pages

On Pro and Unlimited, a page can ask for a password, for an internal audience or a single customer. Visitors see nothing of the page until they enter it.

Your own domain

On Pro and Unlimited, a page can live at a hostname you own, such as status.example.com:

1. Add the hostname on the page’s Domain settings. The panel shows two DNS records.
2. Publish both at your DNS provider: a CNAME for the hostname, and a TXT record at _pingwell.<hostname> that proves the domain is yours.
3. The domain goes live once both records are in place and its certificate is issued, usually within minutes. A domain still pending after seven days is released.

The page stays reachable at its Pingwell address as well.

JSON and a badge

Every public page also serves its current state as JSON at /status.json, for your own dashboards, and a status badge at /badge.svg for a README or a footer.