> ## Documentation Index
> Fetch the complete documentation index at: https://docs.uptimeio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Status badge

> Embed a live status or uptime badge from your status page in a README or website

A status badge is a small image that shows your current status or uptime. Put it in a README, a docs site or your website, and link it to your [status page](https://docs.uptimeio.com/status-pages/creating-a-status-page.md). Badges are available on all plans and are off by default.

## Enable the badge

**1. Open the Settings tab**

Click **Status Pages** in the sidebar, open a page, and select **Settings**.

**2. Turn on the badge**

In the **Status badge** section, select **Enable status badge**, then click **Save Changes**.

**3. Copy a snippet**

Two badges appear with a live preview. Click **Copy** next to the Markdown or HTML snippet of the badge you want, and paste it where you want the badge to show.

The badge links to your status page. If you have a verified [custom domain](https://docs.uptimeio.com/status-pages/custom-domain.md), the snippet uses it. Otherwise it uses your UptimeIO subdomain.

## Badge types

| Badge | Label | Shows |
| - | - | - |
| **Status** | `status` | The overall status of the page: operational, partial outage, major outage, maintenance or unknown. It matches the banner on your public page. |
| **Uptime** | `uptime` | The average uptime across the monitors on the page, for the period you choose, for example `99.95%`. |

For the uptime badge you can choose a period of **24 hours**, **7 days**, **30 days** (default) or **90 days**. The color follows the uptime thresholds you set in the Settings tab: green at or above the operational threshold, amber at or above the degraded threshold, and red below it.

## Example

Replace `your-subdomain` with your status page subdomain.

```markdown theme={null}
[![Status](https://api.uptimeio.com/api/public/status/your-subdomain/badge.svg?type=status)](https://your-subdomain.status.uptimeio.com)
```

The uptime badge takes an optional `period` of `24h`, `7d`, `30d` or `90d`:

```markdown theme={null}
[![Uptime](https://api.uptimeio.com/api/public/status/your-subdomain/badge.svg?type=uptime&period=7d)](https://your-subdomain.status.uptimeio.com)
```

## When the badge shows

The badge only shows for published, public status pages. If the page is a draft, is password protected, or the badge is turned off, the image reads `not found`. Publish the page, remove password protection and enable the badge to use it.

## Related guides

* [Uptime badge for a GitHub README](https://uptimeio.com/guides/github-readme-uptime-badge?utm_source=docs\&utm_medium=related_guides\&utm_content=status-pages-status-badge)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.