Free tools / Status badge builder
Status badge builder
Embed a live SVG badge that shows your status page's current state in a README, docs site, or wiki. It is served from your public page and refreshes every five minutes.
Badge options
The part before .status.scaledpapers.com on your public page.
Left-hand text. Up to 32 characters; try "api", "uptime", or your product name.
Only affects the preview. The real badge always shows the live state.
Preview
rendered locallyHow the status badge works
Every public ScaledPapers status page serves an SVG at https://{slug}.status.scaledpapers.com/badge.svg. The badge reflects the same overall state the page banner shows: open incidents and their impact, plus any active maintenance window. GitHub, GitLab, Notion, and most wikis render it like any other image, and GitHub's image proxy respects the five-minute cache, so a README updates within minutes of an incident being opened or resolved.
Badge states and colours
| Page state | Badge text | Colour | When |
|---|---|---|---|
| Operational | operational | Green | No open incidents, no active maintenance. |
| Minor | degraded | Amber | An open incident with minor impact. |
| Major | partial outage | Orange | An open incident with major impact. |
| Critical | major outage | Red | An open incident with critical impact. |
| Maintenance | maintenance | Blue | A scheduled maintenance window is in progress and nothing else is wrong. |
URL parameters
label: left-hand text, up to 32 characters. Defaults tostatus.style:flat(default),flat-square,for-the-badge, orlanding.
Landing is the style for a site footer or marketing page. It draws a colored dot and a sentence — All systems operational, Degraded performance, Partial outage, Major outage, or Under maintenance — and ignores label. The sentence uses dark type on a light scheme and light type on a dark scheme. Flat, flat square, and for the badge stay the README styles.
The badge is also available at https://scaledpapers.com/s/{slug}/badge.svg with the same parameters. Private (password-protected) status pages do not serve a badge; the URL returns 404 so nothing about the page is exposed.
Frequently asked questions
- How often does the badge update?
- The SVG is cached for five minutes at the edge. A new incident or a resolution shows up on the next fetch after the cache expires; GitHub's camo proxy adds a short delay of its own.
- Can I show one component instead of the whole page?
- Not yet. The badge shows the page's overall state. If you want a per-service badge, create a status page per service; Free includes one page and Pro includes five.
- Does it work on a custom status domain?
- Yes. Pages on a custom domain still answer at
{slug}.status.scaledpapers.com/badge.svg, which is the URL this builder produces, so the badge keeps working if you later change domains. - Where does the badge link?
- The snippets wrap the image in a link to your public status page, so a click from a README lands on the full incident history.
No status page yet?
Create one in a minute: pick a slug, add the checks it should reflect, and the badge is live. Free includes one public status page, email alerts, and 5 checks.