Skip to content
MtrXTools

Status badges

Embeddable SVG badges for READMEs and status pages showing days until certificate expiry, TLS grade, security headers grade, DMARC policy and IPv4/IPv6 support, refreshed every few hours, plus custom badges showing any value from the API, such as the viewer's own IP address.

Five live badges

  • Certificate: days until the TLS certificate expires, amber under 30 days and red under 14.
  • TLS: the SSL checker's grade, A+ to F.
  • Security headers: the HTTP headers grade.
  • DMARC: the domain's policy, none, quarantine or reject.
  • IPv6: whether the name publishes IPv4 (A) and IPv6 (AAAA) addresses: green for IPv4 + IPv6 or IPv6 only, amber for IPv4 only.

Copy the Markdown or HTML snippet into a README, wiki or status page. Each badge links to the full report so readers can see the details.

A custom badge shows any single value from any API result: take an API address such as /api/v1/ssl-checker?q=example.com, change /api/v1/ to /api/badge/v1/ and add &field=grade.letter. The builder loads the result and lists every field, so you can click the one you want. label sets the left-hand text and color the colour (good, ok, warn, bad, info or unknown).

How fresh are they?

Results are cached at the edge for 6 hours, so GitHub's image proxy and other caches don't re-run the checks on every view. Add &label= to the badge URL to change its label text.

Questions

Is there a limit on how many badges I can use?
No. Badges are cached, so even busy READMEs make few real checks.
Why does a badge say "unavailable"?
The check failed when the badge was fetched, for example because the site was unreachable. Error results are cached for only 5 minutes, so it recovers quickly.
Will a badge show a bad result publicly?
Yes, badges show the current result to everyone who views the page. That is the point: they keep certificate and security problems visible until someone fixes them.
Can I show my own IP address on an internal page?
Yes: <img src="https://www.mtrxtools.com/api/badge/v1/my-ip?field=ip"> shows each viewer the public address their browser connects from. It is never cached. It works on pages that load images directly, such as intranets and dashboards, but not on GitHub, which fetches images through its own servers.
Can I use them on a status page or dashboard?
Yes. Any page that can show an image works, including Notion, Confluence and internal wikis that fetch external images.

Related tools