Documentation menu

Status badges

Every public status page has an SVG badge you can embed anywhere images are allowed.

URL

https://app.asniher.com/api/badge/<status-page-slug>.svg

By default the badge shows the overall status of the page, for example status | operational.

Options

Query parameter Effect
type=uptime Show 90-day uptime percentage instead of status. Without monitor, this is the lowest uptime among the page's monitors.
monitor=<monitor-id> Show a single monitor on the page instead of the whole page.
label=<text> Replace the left-hand label. Up to 30 characters. Defaults to status or uptime.

Combine parameters with &:

https://app.asniher.com/api/badge/acme.svg?type=uptime&label=API%20uptime

Embedding

Markdown (GitHub README)

[![Status](https://app.asniher.com/api/badge/acme.svg)](https://acme.status.asniher.com)

HTML

<a href="https://acme.status.asniher.com">
  <img src="https://app.asniher.com/api/badge/acme.svg?type=uptime" alt="Uptime" height="20">
</a>

Caching

Badges are cached for 60 seconds. A status change can take up to a minute to appear. GitHub also proxies README images through its own cache, which can add further delay.

Errors

The badge shows not found (grey) when the slug does not exist, the status page is not public, or the monitor ID is not on that page.

Questions about this page? Email support@asniher.com.