Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
    3. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
      1. Naming monitors
      2. Check frequency
      3. Request timeout
      4. Confirmation and recovery period
      5. Domain expiration checks
      6. SSL certificate checks
      7. Cache busting
      8. Locations and regions
      9. Request parameters, headers and HTTP authentication
      10. Github badge
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations

Github badge

This badge will automatically show the status of the monitor (up or down) directly in your README.md on GitHub.

To find your GitHub badge code, go to Monitors → Select a monitor → Configure → Advanced settings. To add it, copy the markdown code in your monitor's advanced settings and paste it to the top of your README.md file.

The badge code can be used anywhere, not just on GitHub, so feel free to get creative. 🎨

Previous article

Request parameters, headers and HTTP authentication

Next article

Uptime monitor