Skip to content

Using UptimeObserver with shields.io

You can display the status of your monitored services using shields.io badges, which are perfect for README files, dashboards, or status pages.

How it works

UptimeObserver provides a public status endpoint for each monitor. Shields.io can fetch this endpoint and display a badge based on the status or uptime.

Step-by-step Guide

Find your Monitor specific API key

  • Log in to your UptimeObserver dashboard.
  • Go to the monitor you want to display.
  • Copy the API key.
  • Markdown example:
    ![UptimeObserver status](https://img.shields.io/uptimeobserver/status/:your-monitor-api-key)
    
  • HTML example:
     <img alt="UptimeObserver status" src="https://img.shields.io/uptimeobserver/status/:your-monitor-api-key">
    

Examples

Status

![UptimeObserver status](https://img.shields.io/uptimeobserver/status/33Zw1rnH6veb4OLcskqvj6g9Lj4tnyxZ41)

UptimeObserver status

Uptime (1-day)

![UptimeObserver statusUptime](https://img.shields.io/uptimeobserver/ratio/1/33Zw1rnH6veb4OLcskqvj6g9Lj4tnyxZ41)

UptimeObserver Uptime

This badge will automatically update to show the current status or uptime of your service.

Troubleshooting

  • Make sure your monitor's status api key is correct.
  • If the badge does not update, check that the URL is correct and accessible.

For more details, visit shields.io documentation or contact UptimeObserver support.