SVG Badge API

The SVG Badge API generates dynamic status badges that automatically reflect your current system status. Perfect for README files, documentation, and anywhere you need a simple visual status indicator.

Endpoint

GET https://statuspage.me/badge/{slug}.svg

Replace {slug} with your status page slug.

Example Request

https://statuspage.me/badge/your-slug.svg

Response

Returns an SVG image that displays:

• Your status page name (or “Status”)
• Current status with color:
  • Green - Operational
  • Yellow - Degraded Performance
  • Orange - Partial Outage
  • Red - Major Outage
  • Blue - Under Maintenance

Usage Examples

Markdown (GitHub, GitLab, etc.)

![Status](https://statuspage.me/badge/your-slug.svg)

Markdown with Link

[![Status](https://statuspage.me/badge/your-slug.svg)](https://your-slug.statuspage.me)

Clicking the badge takes users to your full status page.

HTML

<img alt="Status" src="https://statuspage.me/badge/your-slug.svg" />

HTML with Link

<a href="https://your-slug.statuspage.me">
  <img alt="Status" src="https://statuspage.me/badge/your-slug.svg" />
</a>

Badge Appearance

The badge follows the shields.io style and looks like:

Common Use Cases

Combining with Other Badges

Works great alongside other shields.io-style badges:

![Build](https://img.shields.io/badge/build-passing-success)
![Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen)
![Status](https://statuspage.me/badge/your-slug.svg)

Caching

• Badges are cached for approximately 5 minutes
• Status changes may take a few minutes to reflect
• For real-time updates, use the Live Widget

Error Handling

If the status page doesn’t exist or there’s an error:

• Returns a gray badge with “Unknown” status
• Doesn’t break your page layout

Plan Requirements

SVG badges require a Pro plan or higher.

Free plans can display their status page publicly but cannot use the badge endpoint.

What’s Next?

• Embed Status API for JSON data
• Live Widget for richer embedding
• Markdown API for copy-paste snippets