Embed an uptime badge

Three SVG badges per status page, all public, all served from happyuptime.com/api/v1/badges/{statusPageId}/.... They look like shields.io badges but pull live data from your status page.

Available badges

text
GET https://happyuptime.com/api/v1/badges/{statusPageId}/uptime.svgGET https://happyuptime.com/api/v1/badges/{statusPageId}/status.svgGET https://happyuptime.com/api/v1/badges/{statusPageId}/response-time.svg

Find your statusPageId in the dashboard → status page → Widgets tab → copy URLs.

Embed in markdown (e.g. README)

markdown
![Uptime](https://happyuptime.com/api/v1/badges/STATUS_PAGE_ID/uptime.svg)![Status](https://happyuptime.com/api/v1/badges/STATUS_PAGE_ID/status.svg)![Response time](https://happyuptime.com/api/v1/badges/STATUS_PAGE_ID/response-time.svg)

Embed in HTML

html
<img src="https://happyuptime.com/api/v1/badges/STATUS_PAGE_ID/status.svg" alt="Service status" />

Style options

Common query parameters:

ParamValuesDefault
styleflat, flat-square, pill, minimalflat
labelCustom left-side labeluptime / status / response time
colorHex without #, e.g. 34d399Auto from status
text
https://happyuptime.com/api/v1/badges/.../uptime.svg?style=pill&label=Operational

Caching

Badges are CDN-cached at the edge for 30s. Don't worry about hammering with refresh — it's serving from cache.

Ask a question... ⌘I