Skip to main content
API overview

API Reference

Badge

Embeddable SVG status badges for README files and dashboards

GET/badge/{orgSlug}
Public

Get status badge SVG

Embed the most severe recorded status among monitorable vendors linked to your organization's projects. An empty dependency set returns Unknown. The badge does not measure application health.

Visibility

This endpoint is public and requires no credential. Anyone with the organization slug can request the aggregate badge. Turn off Settings → Organization → Public Badges to stop sharing it. Disabled badges and unknown organization slugs return the same neutral Private SVG without timestamps. Never put an API token in the URL.

Observation dates

The badge shows the oldest contributing observation date in UTC. Its accessible title includes the exact timestamp and identifies manual status overrides. If any observation has no date, the visible label says date unavailable. Responses have a five-minute cache lifetime and a fifteen-minute stale-while-revalidate window. An old or cached observation does not establish current health. Maintenance is a badge display label; the REST JSON service values are defined by the Status schema.

Use the Left and Right Arrow keys to scroll the table.
Badge stateColorLabel
operationalGreen (#00A855)Operational
unknownGray (#6B7280)Unknown
maintenanceBlue (#0369A1)Maintenance
degradedYellow (#C99400)Degraded
partial_outageOrange (#C84E1A)Partial Outage
major_outageRed (#C42828)Outage
disabled or unknown organizationGray (#6B7280)Private

Parameters

orgSlugstringpathrequired

Organization slug used to select the aggregate badge. This endpoint requires no credential.

Responses

Example Response

JSON
"<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"327\" height=\"20\" role=\"img\" aria-label=\"Recorded deps: Operational. Oldest dated observation: 2026-09-12T08:30:00.000Z. No manual status overrides\">\n  <title>Recorded deps: Operational. Oldest dated observation: 2026-09-12T08:30:00.000Z. No manual status overrides</title>\n  <clipPath id=\"r\"><rect width=\"327\" height=\"20\" rx=\"3\" fill=\"#fff\"/></clipPath>\n  <g clip-path=\"url(#r)\">\n    <rect width=\"111\" height=\"20\" fill=\"#555\"/>\n    <rect x=\"111\" width=\"216\" height=\"20\" fill=\"#00A855\"/>\n  </g>\n  <g fill=\"#fff\" text-anchor=\"middle\" font-family=\"Verdana,Geneva,DejaVu Sans,sans-serif\" text-rendering=\"geometricPrecision\" font-size=\"11\">\n    <text x=\"55.5\" y=\"14\" fill=\"#fff\">Recorded deps</text>\n    <text x=\"219\" y=\"14\" fill=\"#0A0A0A\">Operational · 2026-09-12 UTC</text>\n  </g>\n</svg>"

Code Samples

Code
curl https://checkupstream.com/api/v1/badge/acme -o badge.svg

Add a public badge

Public badges need no credential. Choose an embed for your repository or website.