Status Badges

Embed real-time uptime and status badges in your documentation

What are Status Badges?

Status badges are SVG images that display real-time information about your services. They can be embedded in README files, documentation, status pages, or anywhere on the web.

  • Uptime Badge: Shows the percentage uptime over a specified period
  • Status Badge: Shows the current operational status of the service
  • All badges are cached for optimal performance
  • Available in multiple styles: flat, flat-square, plastic
Loading services...

Usage Guide

URL Parameters

  • days: Number of days for uptime calculation (1-365, default: 30)
  • style: Badge style - flat, flat-square, plastic (default: flat)

Examples

  • 90-day uptime: ?days=90
  • Flat-square style: ?style=flat-square
  • Combined: ?days=90&style=flat-square

API Endpoints

  • Uptime: /api/badges/{serviceSlug}/uptime.svg
  • Status: /api/badges/{serviceSlug}/status.svg
  • JSON Info: /api/badges/{serviceSlug}/info.json

Documentation

For more information and full API documentation, visit:

API Documentation →