Skip to main content

​
Overview

The Get Check Status Badge endpoint generates status badges (SVG images) that display the current health status of a specific check. Use these badges in documentation, dashboards, and status displays. Common Use Cases:
  • Documentation Status Display
  • README Badge Integration
  • Dashboard Widgets
  • Public Status Communication
Response Format: SVG image
Status badges update automatically based on check results. Embed badge URLs directly in markdown, HTML, or documentation platforms for live status updates.