Skip to content

Docs

Add a status badge to your README or website

A badge shows at a glance whether everything is up, and links to the full status page. It updates on its own.

Updated 25 October 2026 · By the Upcertain team

Get the code

  1. Open the status page's settings and find Status badge. Badges are available for public pages.
  2. Choose the text badge or the logo badge.
  3. Copy the Markdown, the HTML or the website embed.
[![Acme status](https://upcertain.com/badge/acme.svg)](https://upcertain.com/s/acme)
<a href="https://upcertain.com/s/acme"><img src="https://upcertain.com/badge/acme.svg" alt="Acme status"></a>

Styles and states

BadgeWhat it says
Text (?style=text, the default)All services are up, Partial outage, Major outage or Maintenance
Logo (?style=logo)The Upcertain mark with up, partial outage, down or maintenance

Add &theme=dark for a dark background, for example https://upcertain.com/badge/acme.svg?style=logo&theme=dark. The state is spelled out in words, not only shown by colour.

Freshness

The badge is an SVG image cached for one minute, so it follows the page's state closely without slowing your site. GitHub caches images through its own proxy, which can add a few minutes in READMEs.

Where to put it

  • The README of your API client or SDK, next to the version badge.
  • Your documentation's header or footer.
  • Your app's help or support page.

Questions

Does the badge work for password-protected pages?
No. Badges are offered for public pages only, so a badge never reveals the state of a protected page.
Can I change the badge's wording?
No. The wording follows the page's state so it always matches the status page.