← Blog
New feature 4 min read

Add an Uptime Badge to Your GitHub README

PingBase now generates embeddable SVG badges showing your monitor's live uptime percentage. Add it to your README, docs, or website — one line, always current.

Uptime 99.98% uptime 99.98%
uptime 97.2%
status degraded

Live SVG badge

Color changes automatically — green above 99%, amber above 95%, red below.


Why add an uptime badge?

An uptime badge in your README does two things. First, it signals to potential users and contributors that your project is actively monitored and reliable — the same way a passing CI badge signals that the code works. Uptime is a proxy for maintenance quality.

Second, it's a link. Every developer who clicks the badge to see your status page is one click from the PingBase homepage. We're not shy about this — it's the same growth model as Calendly's "Schedule with Calendly" links and Vercel's "Deployed on Vercel" badges. The badge is good for you (shows reliability) and for us (distribution). Fair trade.


How to get your badge URL

  1. Open any monitor in your PingBase dashboard
  2. Click the Badge tab in the monitor detail view
  3. Copy your badge URL or the pre-formatted embed code for Markdown or HTML

Your badge URL looks like this:

https://api.pingba.se/api/badge/YOUR_MONITOR_ID

The badge is a shields.io-style SVG cached at the edge for 60 seconds — so it's always current without hammering your end. GitHub renders SVG badges inline in READMEs automatically.


Embed code examples

GitHub README (Markdown)

[![Uptime](https://api.pingba.se/api/badge/YOUR_MONITOR_ID)](https://YOUR_STATUS_PAGE_URL)

Replace YOUR_MONITOR_ID with your monitor's ID from the PingBase dashboard. The badge links to your status page when clicked.

GitLab README (Markdown)

[![Uptime](https://api.pingba.se/api/badge/YOUR_MONITOR_ID)](https://YOUR_STATUS_PAGE_URL)

Identical syntax to GitHub — GitLab renders Markdown badges the same way.

HTML (docs, website, blog)

<a href="https://YOUR_STATUS_PAGE_URL">
  <img src="https://api.pingba.se/api/badge/YOUR_MONITOR_ID"
       alt="Service uptime status" />
</a>

reStructuredText (PyPI, Sphinx docs)

.. image:: https://api.pingba.se/api/badge/YOUR_MONITOR_ID
   :target: https://YOUR_STATUS_PAGE_URL
   :alt: Uptime status

Badge colors and what they mean

Uptime (30-day) Badge color Meaning
99%+ green Excellent — enterprise-grade reliability
95–99% amber Some incidents this month
<95% red Significant downtime this month
Currently down red Active incident in progress

Available on all plans

Uptime badges are available on all PingBase plans, including free. Every monitor gets a badge URL — no plan upgrade required to show your reliability publicly.


Add your first badge in 60 seconds

Create a free account, add a monitor, grab the badge URL from the Badge tab. No credit card required.

Get your uptime badge →