Status pages
A status page tells your customers what is up and what is not, without them having to ask. It is built from your uptime monitors, so it updates itself.
| Free | Starter | Growth | MSP | |
|---|---|---|---|---|
| Published status pages | Not included | 1 | 3 | 25 |
Building a page
- Title and address. The address (slug) is generated from the title if you do not choose one. It must be unique.
- Components. Pick monitors to show. Give each a customer-friendly display name and an optional group name. drag them into order.
- Description and logo. A short description, and a logo given as an https:// URL.
- Show uptime. Include the uptime percentage history.
- Auto notify. Send subscribers a message automatically when status changes.
- Published. A page is private until published. Publishing counts toward your plan limit, and unpublishing frees the slot.
Incident updates
Post a manual update with a status, a title and a message, for example while you investigate an outage. Published pages email confirmed subscribers about an update unless you switch notification off for that post. Analysts can post and delete updates.
Custom domain
- Enter a subdomain you control, such as
status.example.com. Bare Bermward hostnames are refused. - Create the CNAME record Bermward shows, pointing your subdomain at Bermward.
- Create the verification TXT record shown on the page, then press Verify.
Each custom domain can belong to one status page. Removing the domain clears the verification. Only admins manage domains.
Subscribers
Visitors subscribe with an email address on the public page, confirm through a link, and can unsubscribe from any message. Subscriptions are rate limited per hour. Admins can see the list and remove subscribers.
Machine-readable status
Each public page also serves status.json beside it: the same data as the page, open to cross-origin requests, so you can show your status inside your own site or app.
Branding
On a plan with white label, pages carry your name and logo instead of Bermward's. See Branding.
| Role | Can |
|---|---|
| Viewer | See pages and their updates. |
| Analyst | Edit content and components, publish or unpublish, post and delete updates. |
| Admin | Create and delete pages, manage custom domains and subscribers. |
API
| Method | Path | Role | What it does |
|---|---|---|---|
GET | /api/orgs/:orgId/status-pages | viewer | List pages with component and subscriber counts. |
POST | /api/orgs/:orgId/status-pages | admin | Body: title, optional slug and monitorIds. |
GET | /api/orgs/:orgId/status-pages/:pageId | viewer | One page, with DNS instructions when a custom domain is set. |
PATCH | /api/orgs/:orgId/status-pages/:pageId | analyst | title, slug, description, logoUrl, published, showUptime, autoNotify, components. |
DELETE | /api/orgs/:orgId/status-pages/:pageId | admin | Delete. |
PUT | /api/orgs/:orgId/status-pages/:pageId/domain | admin | Body: domain, or null to remove. |
POST | /api/orgs/:orgId/status-pages/:pageId/domain/verify | admin | Check the verification record. |
POST | /api/orgs/:orgId/status-pages/:pageId/updates | analyst | Body: state, title, body and optional notify. |
DELETE | /api/orgs/:orgId/status-pages/:pageId/updates/:updateId | analyst | Delete an update. |
GET | /api/orgs/:orgId/status-pages/:pageId/subscribers | admin | List subscribers. |
DELETE | /api/orgs/:orgId/status-pages/:pageId/subscribers/:subscriberId | admin | Remove one. |