Skip to content
Browse all docs

Monitors

Uptime badges

Embed a live status or uptime SVG in a README or website.

An embed is a public, unguessable token covering the monitors you pick, either everything in the workspace or a chosen subset. It renders as a live SVG badge (for READMEs and docs) or a website status pill, showing one aggregated status: if any included monitor is down the embed is down, and uptime is pooled across all included checks. Visitors see a label, a status, and a percentage, nothing else about your workspace.

  1. 01

    Create an embed

    Open Embeds in the dashboard sidebar and create one. Each embed gets its own URL, so you can have one covering everything and another for a single product.

  2. 02

    Pick the monitors

    Leave it on all monitors, or switch the toggle off and select a subset. The badge and widget update as soon as you change the selection.

  3. 03

    Copy and paste

    For badges: Markdown for READMEs, HTML for websites, or the raw URL. Pick a variant first: Status (up, degraded, down, paused) or Uptime over 24h, 7d, 30d, or 90d. The Link to picker chooses where clicks land: your status page domain or its Uptimix subdomain.

Markdown

[![My API status](https://uptimix.com/badge/<token>.svg)](https://example.com)
type
status (default) or uptime.
range
For uptime badges: 24h, 7d, 30d (default), or 90d.
label
Overrides the left-hand text. Defaults to the embed name for status badges and to <name> uptime 30d style text for uptime badges.

Website widget

For your own site's footer there is a live widget: a rounded pill with a pulsing status dot ("All systems operational"), optionally with the 30-day uptime next to it. Copy it from the embed as plain HTML or as a React component; both are self-contained, refresh once a minute via /badge/<token>.json, and inherit your site's text color.

Rotating an embed's URL generates a new token immediately; anything using the old URL shows a "not found" badge until you update it. Deleting an embed does the same, permanently.