API Reference

Badge.

Embeddable SVG status badges for README files and dashboards

GET/badge/{orgSlug}

Bearer Token

Returns an SVG badge showing the worst health status across all services your organization depends on. Embed this in dashboards or internal tools.

The badge reflects the most severe status: if any service is in major_outage, the badge shows red. Responses are cached for 5 minutes.

Parameters

orgSlugstringpathrequired

Organization slug for URL readability. The actual organization is determined by the API key.

Responses

Code Samples

curl -H 'Authorization: Bearer YOUR_API_KEY' \
  https://checkupstream.com/api/v1/badge/acme -o badge.svg

Build with the API.

Generate an API token and start querying these endpoints from your CI, scripts, or backend services.