Badges

Embeddable SVG badges for your README files, docs, and status pages. Drop them in with a single <img> tag.

Examples

platform: operationaloverall platform health
deploys: okdeploy success rate
api: upAPI uptime
builds: degradedbuild queue depth
node: v0.2.0CLI version (custom status)
license: MITlicense (custom status)

How to use

Drop the URL into an <img> tag. The badge is server-rendered SVG so it scales perfectly at any size.

<!-- Markdown -->
![hosting](https://www.hostkingpro.com/api/badge?label=hosting&status=operational)

<!-- HTML -->
<img src="https://www.hostkingpro.com/api/badge?label=hosting&status=operational"
     alt="hosting: operational" />

<!-- Auto-updating (re-render every 5 min) -->
<img src="https://www.hostkingpro.com/api/badge?label=builds&status=ok"
     alt="builds" />

Color reference

The status param maps to a color automatically. Override with color=.

color: greengreen
color: amberamber
color: redred
color: blueblue
color: greygrey

Status keywords: up / ok / operational / active = green, degraded / slow = amber, down / failed = red.

Cache

Badges are cached for 5 minutes. If you change a status, give it 5 minutes to propagate. (For real-time status, just hit the API endpoint directly.)

See also: /status for the full system status page, /api/readyz for machine-readable health.