Status Badges
Overview
Section titled “Overview”OKStatus can serve a small SVG image showing a monitor’s live status, uptime percentage, or response time — the kind of badge you’d drop into a README, a status widget, or an internal dashboard. Badges are public: no API key or authentication needed, since they’re keyed by the monitor’s unguessable ID (same trust model as a public status page’s slug).
Monitor badge (animated)
Section titled “Monitor badge (animated)”The friendliest option — a compact, animated live-status badge for one monitor:
<img src="https://okstatus.eu/badge/YOUR_MONITOR_ID" alt="Status" />Find YOUR_MONITOR_ID in the monitor’s detail page URL in the dashboard. Add ?animated=false for a static version:
Metric badges (shields.io style)
Section titled “Metric badges (shields.io style)”Three flat, single-metric badges, one endpoint per metric. These are served by
the public API host (api.okstatus.eu), not the app domain:
| Badge | URL |
|---|---|
| Status | https://api.okstatus.eu/badge/monitor/:id/status |
| Uptime | https://api.okstatus.eu/badge/monitor/:id/uptime?range=30d |
| Response time | https://api.okstatus.eu/badge/monitor/:id/response-time |
The uptime badge’s range accepts 7d, 30d, or 90d (defaults to 30d).
Like the animated badge above, they need no API key — the monitor’s unguessable
UUID is the credential.
Status page badge
Section titled “Status page badge”For a whole status page rather than a single monitor — a rounded “pulse” pill showing the page’s aggregate state (All systems operational, Degraded performance, Partial outage, Major outage):
Both slugs match the ones in your status page’s public URL —
okstatus.eu/YOUR_ORG_SLUG/status/YOUR_PAGE_SLUG. Add ?animated=false for a
static version.
The status page editor (Status Pages → your page → Embed) shows a live preview of this badge with a ready-to-paste snippet, plus the floating status widget.
Caching
Section titled “Caching”Badges are cached for 60 seconds (Cache-Control: max-age=60) — embedding one in a high-traffic README won’t hammer OKStatus, but also means a status change can take up to a minute to show up in the badge.