Status pages

A status page is a public page that shows the live status of the sites and heartbeats you choose, the incidents you post and the maintenance you've planned. This page covers how to create one, brand it, choose what it shows and run an incident from start to finish. Custom domains, subscribers and feeds, contacts and maintenance windows each have their own page, linked at the end.

Create a page

Open Status Pages in the sidebar and create a page. Two fields are required.

• Name. Shown only inside OctoPing. The public title is a separate field.
• Slug. The page is served at /status/{slug}. A slug uses lowercase letters, numbers and hyphens, is at least 3 characters long and can't start or end with a hyphen. Slugs are unique across all of OctoPing, so a slug someone else already uses is refused with a message that it already exists.

A new page is a Draft. Nobody outside your workspace can open it until you switch it to Published with the toggle at the top of the page. A draft or deleted page answers HTTP 404 at its public address, although an unpublished page can stay visible for up to a minute. While a page is a draft you can still check it with Open live preview under Preview, which shows real monitor data and real incidents.

The public page can take up to 60 seconds to show a change you save, such as a new incident, a settings change or unpublishing. The status of a monitored item can be the same amount behind the app.

Who can do what

A Viewer sees the page's settings and incidents in the app but can't change them.

What the page says about your business

These fields sit under Basic Information in the page's settings.

Branding and appearance

Branding and Style & Appearance are separate sections of the page's settings.

Logo and header image

A logo shows beside the page title. A header image shows as a banner above it, and only when Header Style is Banner. Each file can be up to 2 MB and must be one of these types: PNG, JPEG, GIF, SVG, WebP or ICO. A larger file or another type is refused with an error naming the problem.

Colors, shape and layout

Colors are hex values such as #4F46E5. Three switches choose what each item shows.

Custom CSS is added to the page and to its incident pages inside a style tag. Use it for small adjustments on top of the settings above.

Choose what the page shows

A page lists items. An item is one website or one heartbeat from the same workspace. Use Add Item to pick one, and the item reads its status from the monitor, so there is nothing to keep in sync.

Each item shows one of the public statuses and the banner at the top shows the worst of them. The statuses and the rules behind them are listed on Statuses, and uptime on the page is the 90-day figure described on Uptime, downtime and outages. Planned work from a maintenance window shows in its own Scheduled maintenance section.

Run an incident

An incident is a note you write for your clients. OctoPing never opens one on its own, because a failed check and a message to your clients are different decisions. Incidents live under Incidents on the page.

Declare it

Choose Declare incident and fill in a title, an impact, an initial update and, if you want, the components it affects. Started at is optional and defaults to now. Set Status to Investigating, or to Resolved if you're writing up something that's already over.

The lifecycle

The status of an incident moves through Investigating, Identified, Monitoring and Resolved. You change it by posting an update, and each update keeps the status it was posted with, so the public timeline reads in order. Resolving sets the resolved time. Posting an update with an earlier status on a resolved incident reopens it.

Impact

Impact describes how much it affects your clients and is one of None, Minor, Major and Critical. It labels the incident and doesn't change the status of any item.

Affected components

Mark each affected component with Degraded performance, Partial outage and Major outage. While the incident isn't resolved, the page shows that status for the component in place of the one OctoPing measured, and it counts toward the banner. When more than one open incident affects a component, the most severe status wins. Resolving the incident removes the override, and the component goes back to what the monitor reports.

Editing and deleting

Editing an incident changes its title, impact, start time and affected components. It doesn't change the status or any update. A Member can edit an incident, and an Admin can delete one along with its timeline.

What visitors see

Open incidents show at the top of the page. Incidents resolved in the last 14 days follow under Past Incidents, and the full history is at /status/{slug}/incidents. Visitors can follow incidents by email or by feed, which Subscribers and feeds covers. The same data is available as JSON on Status page JSON.

Custom head and body code

Under Advanced the settings page has two text areas, Custom code in <head> and Custom code in <body>. The backend stores both with the page and doesn't tie either to a plan.

Delete a page

An Admin can delete a status page. Its items, incidents and subscribers go with it, its slug becomes free to use and any custom domain on it stops resolving to a page. The monitors it listed aren't touched.

Related pages

• Custom domains serve a page at your client's own address.
• Subscribers and feeds let visitors follow your updates.
• Contacts send your clients every alert and a monthly summary.
• Maintenance windows announce planned work.