Status badge builder
Put your live service status in your README, your docs, or your company site. Enter your Uptimely status page and copy the snippet — the badge is served by Uptimely and shows the current state every time someone loads the page it sits on.
What it looks like
The badge carries your status page’s name and its current overall status — green while the page has components and every one of them is operational, amber whenever one is not. A page with no components on it yet is amber too: there is nothing on it to report as healthy. It is sized to fit whatever your page is called, so a longer name makes a wider badge.
What you need first
A public status page in Uptimely. The badge is an anonymous image with no sign-in step, so it is served only for pages you have marked public; a private page returns nothing rather than leaking its state. The Free plan includes a status page — see the plans.
Build your snippet
The slug from your status page’s address, or paste the whole URL. In Uptimely it is on the status page’s own settings, under Embedded Status.
https://app.getuptimely.com/status/acme/badgeThe image itself. Point anything that renders an image at it.
<img src="https://app.getuptimely.com/status/acme/badge" alt="Status Badge" />For a company site, a docs page, or an internal dashboard.
For a README on GitHub, GitLab or anywhere else Markdown renders.
[](https://app.getuptimely.com/status/acme)The same badge, clickable — a reader who sees red can get the detail in one click.
Open the live badge for acme — if it does not load, there is no public status page with that slug, which is also exactly what a reader of your README would see.
These are the same four snippets Uptimely generates inside the app, under a status page’s Embedded Status settings — that screen also shows a live preview of your own badge. Nothing you type here is sent anywhere; the snippets are assembled in your browser.
A badge is a claim you have to keep
It is only worth embedding if the status behind it is measured rather than remembered. Uptimely checks as often as every minute, declares an incident when checks genuinely fail, and publishes the same history on your status page. Work out what your uptime target allows.
Status pages, unlimited
One on Free, as many as you need on Pro — with custom domains, your own branding, subscriber notifications and a public response-time chart. See what is included, or what shipped recently.
What is a status badge?
A small image that shows whether a service is up right now, embedded in a README, a documentation page or a company site. It is served live, so it reflects the current state every time someone loads the page it sits on rather than whenever it was last edited.
Do I need an Uptimely account to use one?
Yes — the badge reads the current state of a status page, so you need a status page for it to read. Uptimely's Free plan includes one, along with ten monitors, and you can build the page before you decide to pay for anything.
Does the badge work for a private status page?
No, and deliberately so. The badge is an anonymous image with no sign-in, so it is served only for status pages marked public — a private page returns nothing rather than leaking its state to anyone who can guess the address.
What does the badge show?
Your status page's name and its current overall status, coloured green when the page has components and every one of them is operational, and amber otherwise — including a page with no components yet, which has nothing to report as healthy. It is one line about the whole page, not a per-component breakdown; the page itself is where the detail lives.
How often does the badge update?
It is generated on request and cached for five minutes, so a change in status reaches a README within about that long. GitHub and some other hosts also proxy images through their own cache, which can add a little more.
Can I put the badge on GitHub?
Yes — that is what the Markdown snippet is for. Paste it into your README and it renders like any other badge; the linked version makes it clickable so a reader who sees a problem lands on your status page with the detail.