- Docs
- /
- Status Pages
- /
- Badges
Status Page Badges Beta
A badge is a small image of what your public status page says. Put it in a README, a help center or your site footer, and it links back to the page.
What Each Badge States
Every badge repeats the page in the page's own words. It never reaches a verdict of its own.
The whole page
States the banner at the top of the page: operational, degraded, partial outage, major outage, maintenance, not reporting (a service has no recent checks) or no components. Its color is the banner's color.
One service
States the service's row on the page, named as the row is: operational, degraded, partial outage, major outage, maintenance or unknown. A group states its group row.
A service's uptime
The uptime figure the service's row prints for the last 30 or 90 days, in the same color. Where the row shows a dash (no checks in the period, or no recent checks), so does the badge. A cron job's badge reads success, as its row does.
The 90-day figure is offered when the page shows 90 days of uptime history (Display tab).
Adding a Badge
Copy a ready-made snippet from the status page editor
- Open Status Pages and choose your page
- On the General tab, find the Badges card
- Under Show, pick the whole page or one service
- Under Value, pick its current status or its uptime
- Copy the Markdown or the HTML and paste it where the badge should appear
Markdown (README files)
[](https://acme.status.flarewarden.com)HTML (websites)
<a href="https://acme.status.flarewarden.com"><img src="https://acme.status.flarewarden.com/badge.svg" alt="Acme status"></a>A page on your own domain serves its badge there too, for
example https://status.yourcompany.com/badge.svg.
Badge Address
What the copied snippet contains, if you prefer to write it yourself
| Address | States |
|---|---|
| /badge.svg | The page's banner |
| /badge.svg?component=ID | One service's or group's row. The Badges card fills in the ID. |
| …&metric=uptime_30d | That service's uptime for the last 30 days (uptime_90d for 90 days) |
Freshness and What a Badge Reveals
A badge shows nothing the page does not
- A badge can be up to a minute behind the page. Some image proxies, such as the one GitHub puts in front of README images, may keep their copy a little longer.
- Only services the page shows can have a badge. A badge for anything else does not load.
- When you disable or delete the page, its badges stop loading too.
- Badges are in beta and come with every status page, on every plan.