Skip to main content
Every public status page exposes three machine-readable surfaces alongside the HTML page: an SVG badge, a JSON status document, and Atom/RSS feeds. All of them live on the page’s own domain, work without authentication, and respect the page’s access mode (a password-protected or sign-in protected page serves a neutral restricted badge and denies the JSON document).

Badge

Embed in a README:

Parameters

Examples:
The status badge is cached for one minute and the uptime badge for five, with a stale-while-revalidate window, so README embeds stay fast and a status flip appears within minutes.

JSON status

Returns the page’s current verdict, incident and maintenance counts, and 30-day uptime. Suitable for dashboards, CLI checks, and uptime aggregators. The shape:
status is one of healthy, degraded, unhealthy, maintenance, or no_data. status_label is the matching word shown on the badge: operational, degraded, outage, maintenance, or unknown. The slos array carries the page’s public SLOs (the same set the page renders): name, owning service, target, window, and remaining error budget. It is empty when no SLO on the page is marked public or the plan does not include public SLO visibility. A budget of null means the SLO is still collecting its first day of observation.

Feeds

Incident and maintenance history as a standard feed. Most chat tools and feed readers can subscribe directly. Each entry links to the update’s permalink, /incidents/<id>.

Maintenance calendar

Scheduled maintenance as an iCalendar feed that Google Calendar, Apple Calendar, and Outlook can subscribe to. See Upcoming maintenance and the calendar feed.

Custom domains

All of these surfaces work unchanged on a page’s custom domain once it is active: https://status.yourdomain.com/badge.svg and so on.
Badge on the page you are readingObserver’s own status page serves the same badge:
https://status.use.observer/badge.svg