Publish a status page for your customers
Show the people who use your API how your monitors are doing, on a public page with 90 days of history - never a request, an address or a body.
In short
A status page shows strangers whether your API works now and how it did over the last 90 days, from the monitors you choose. It shows each monitor under the name you give it, never a request, an address, a header, a body, a run or a person.
Before you start
- The project needs at least one monitor. See /help/api-testing/monitors-and-alerts.
- Confirm your email address. Publishing needs people who manage the project.
- Who: only people who manage the project publish or change the page.
- Plan: monitoring must be on your plan. The page shows the monitors you tick.
Steps
- Open the project's "Watch" › "Monitors". Under the list, the card "Share a public status page" shows its state; press "Set it up" (or "Manage the page").
- Switch on "Publish the status page".
- Under "Monitors to show", tick up to 20 monitors and give each a "Name on the page". Order them with the arrows.
- Write a "Title" and an "Introduction" if you like, and tick "Show the workspace logo".
- Press "Save", then "Copy link" to share the address.
Result: the page says "All services are working", "Some services have problems" or "Services are down", with one bar a day and the incidents in plain words. It refreshes every minute.
Good to know
- Off by default, search engines are asked to stay away and only people with the link find the page. "Let search engines list it" asks you to confirm first.
- "New address" stops the old link at once. "Remove" ends the address for good; your monitors are not changed.
- A day is "some checks failed" or "most checks failed" by the share of checks that failed. An incident is a run of failed checks.
- The logo is only the one uploaded in the organization settings.
- Outside access lists the page, so an administrator can see and end it.
What the page never shows Requests, addresses, headers, bodies, runs and people never reach the page. Check each monitor's name on the page - that is what strangers read.
If something goes wrong
- "Confirm your email address first. A status page is an address anyone with the link can open."
- "Choose at least one monitor for the status page to show."
- "Moderators took this page down" - it shows nothing until moderators lift it.
- "The page shows nothing right now" - the workspace cannot serve public pages at the moment, for example while it is paused.
Related
- /help/api-testing/monitors-and-alerts
- /help/designer/service-health-targets
- /help/organizations/made-with-line