Status badges
A Status badge is a small image that shows one Monitor’s status in a README or on your website. Each badge links to your Status page.
A badge belongs to one Monitor on your Status page. It says only what the page says about that Monitor.
The two styles
Section titled “The two styles”Each style is an image at its own address. You choose a style by the address you copy, and there is nothing to save.
| Style | Beside the Monitor's name | Address |
|---|---|---|
| Status | Its Status word, in small letters: operational, down, no data or not monitored. | https://acme.uupstatus.com/badge/mon_01K5XQ8F7H2M3N4P5Q6R7S8T9V.svg |
| Uptime | Its uptime over the last 90 days, as the Status page prints it under its row. | https://acme.uupstatus.com/badge/mon_01K5XQ8F7H2M3N4P5Q6R7S8T9V/uptime.svg |
A badge’s colors are fixed, and it reads on a light and on a dark background. It has no colors, words or link of your own choosing.
Getting a badge
Section titled “Getting a badge”- In the sidebar, open Status badges. Or press Get a badge on the Status page screen, or on a Monitor.
- Choose the Monitor.
- Under Choose a style, choose Status or Uptime. The preview shows the badge at its real size, on a light and a dark background.
- Copy the Markdown, the HTML or the Image URL.
For the Monitor API on the page at acme.uupstatus.com, the screen offers these.
Status
Section titled “Status”Markdown, for a README:
[](https://acme.uupstatus.com/)HTML, for a website:
<a href="https://acme.uupstatus.com/"><img src="https://acme.uupstatus.com/badge/mon_01K5XQ8F7H2M3N4P5Q6R7S8T9V.svg" alt="API status"></a>Image URL, on its own:
https://acme.uupstatus.com/badge/mon_01K5XQ8F7H2M3N4P5Q6R7S8T9V.svgUptime
Section titled “Uptime”Markdown, for a README:
[](https://acme.uupstatus.com/)HTML, for a website:
<a href="https://acme.uupstatus.com/"><img src="https://acme.uupstatus.com/badge/mon_01K5XQ8F7H2M3N4P5Q6R7S8T9V/uptime.svg" alt="API uptime"></a>Image URL, on its own:
https://acme.uupstatus.com/badge/mon_01K5XQ8F7H2M3N4P5Q6R7S8T9V/uptime.svgEvery snippet uses your page’s own address. When your page has a Custom domain, the snippets use it.
A Monitor that is not on the page
Section titled “A Monitor that is not on the page”Only a Monitor on your Status page has badges. For a Monitor that is not on it, the screen offers Show on the Status page, which puts it there.
When you take a Monitor off the Status page, its badges stop working. Put it back to bring them back, at the same addresses.
Badges you already pasted
Section titled “Badges you already pasted”A badge answers on every address your page answers on. A badge you pasted keeps working after you connect a Custom domain, and for 30 days after you change your page’s address.
When a Project is suspended, its badges say not published.