Beacon

Integrations

Status badges

Small SVG badges showing the current status or 30-day uptime of a status page or a single component. Use them in a README, docs site or wiki.

Badge URLs

https://usebeacon.pro/badge/your-workspace/your-page.svg
https://usebeacon.pro/badge/your-workspace/your-page.svg?type=uptime-30d
https://usebeacon.pro/badge/your-workspace/your-page/123.svg
https://usebeacon.pro/badge/your-workspace/your-page/123.svg?type=uptime-30d
  • type=status (default) shows the worst current component status for a page, or the component's own status.
  • type=uptime-30d (alias type=uptime) shows uptime over the last 30 days from monitor checks: the same figure as the public page for a component, and the average across monitored components for a page. Without monitor data it reads "no data".
  • The number in a component badge URL is the component id, shown in the component's address in the dashboard.

Embedding

Copy ready-made Markdown and HTML from the Status badges card in your status page settings, or write it yourself:

[![Status](https://usebeacon.pro/badge/your-workspace/your-page.svg)](https://usebeacon.pro/status/your-workspace/your-page)

<a href="https://usebeacon.pro/status/your-workspace/your-page">
  <img src="https://usebeacon.pro/badge/your-workspace/your-page.svg?type=uptime-30d" alt="Uptime">
</a>

Caching and privacy

  • Badges are served with Cache-Control: public, max-age=300, so a change can take up to 5 minutes to show (longer if a proxy such as GitHub's image cache holds it).
  • Unpublished pages and private pages (password or members only) always return 404, even for signed-in members.