Skip to content
cronitorex.com

Uptime badge for your README

This content is not available in your language yet.

Every enabled status page serves a badge as an SVG at a stable URL. Paste it in a README and readers see whether the thing you built is up, without clicking anything.

https://app.cronitorex.com/s/<your-page-slug>/badge.svg

Markdown, linking the badge back to the full status page:

[![Status](https://app.cronitorex.com/s/acme-status/badge.svg)](https://app.cronitorex.com/s/acme-status)

The panel generates this snippet for you: open the status page in Status pages → your page, scroll to Uptime badge and copy the field.

What it shows and what it does not

The badge is derived from the status page it belongs to, and shows nothing beyond what that page already shows publicly. There is no key, no token and no separate privacy setting, because there is no separate decision to make: if the monitor is published on a public status page, its badge is public too.

A disabled status page returns 404, identical to a slug that never existed.

Options

ParameterValuesEffect
monitordisplay name of one monitor on the pageBadge for that monitor instead of the whole page
metricstatus (default), uptime30, uptime90Show a status word or an uptime percentage
labelany text, up to 40 charactersReplaces the left half of the badge
styleflat (default), flat-squareRounded or square corners
![Backups](https://app.cronitorex.com/s/acme-status/badge.svg?monitor=Nightly%20backup&metric=uptime30&label=backups)

Two behaviours worth knowing, because both are deliberate:

  • A misspelled monitor name returns 404, rather than a badge reading “unknown”. A typo should be visible the day you make it, not six months later when someone notices the badge has been meaningless the whole time.
  • metric=uptime30 on a monitor with no data falls back to the status word. A percentage is not invented from an empty sample. For the same reason there is no page-wide uptime percentage: averaging monitors with wildly different traffic produces a number that looks precise and means nothing.

Colours

ColourStatusUptime
Greenoperational99% and above
Amberdegraded95% to 99%
Reddownbelow 95%
Greyunknown, nothing reported yetno data

Caching

The badge sends Cache-Control: public, max-age=60 and an ETag. GitHub and most README hosts proxy images through their own cache, so expect up to a few minutes of delay before a status change shows up in a README even though the status page itself is already current. That is a property of the proxy, not of the badge.

The SVG is self-contained: no external fonts, no scripts, no remote images. It renders the same in a README, a wiki, a docs site or a plain <img> tag.