Markdown Snippets API

The Markdown Snippets API returns ready-to-use code snippets for embedding your status page in various formats. Perfect for documentation sites, READMEs, and wikis.

Endpoint

GET https://statuspage.me/api/embed/markdown

Parameters

Example Request

curl "https://statuspage.me/api/embed/markdown?slug=your-slug"

Example Response

{
  "status_page_url": "https://your-slug.statuspage.me",
  
  "badge_markdown": "[![Status](https://statuspage.me/badge/your-slug.svg)](https://your-slug.statuspage.me)",
  
  "badge_html": "<a href=\"https://your-slug.statuspage.me\"><img alt=\"Status\" src=\"https://statuspage.me/badge/your-slug.svg\" /></a>",
  
  "widget_script": "<script src=\"https://statuspage.me/static/embed/v1/status.js\" data-slug=\"your-slug\" data-theme=\"auto\"></script>",
  
  "widget_html": "<div>\n  <script src=\"https://statuspage.me/static/embed/v1/status.js\" data-slug=\"your-slug\" data-theme=\"auto\" data-show-incidents=\"1\" data-rtm=\"60\" data-upd=\"7\"></script>\n</div>",
  
  "minimal_md": "**Status:** See live status → [https://your-slug.statuspage.me](https://your-slug.statuspage.me)"
}

Response Fields

Using the Snippets

For GitHub README

Copy badge_markdown and paste at the top of your README.md:

# My Project

[![Status](https://statuspage.me/badge/your-slug.svg)](https://your-slug.statuspage.me)

Description of your project...

For Documentation Sites

Use badge_html or widget_html in your docs:

<!-- In your docs header -->
<div class="status-badge">
  <a href="https://your-slug.statuspage.me">
    <img alt="Status" src="https://statuspage.me/badge/your-slug.svg" />
  </a>
</div>

For Website Footer

Use widget_script for a dynamic status display:

<footer>
  <div class="footer-status">
    <script 
      src="https://statuspage.me/static/embed/v1/status.js" 
      data-slug="your-slug" 
      data-theme="auto">
    </script>
  </div>
</footer>

JavaScript Integration

Fetch snippets dynamically to keep them updated:

async function getEmbedSnippets(slug) {
  const response = await fetch(
    `https://statuspage.me/api/embed/markdown?slug=${slug}`
  );
  const data = await response.json();
  
  // Display in a code block for users to copy
  document.getElementById('badge-markdown').textContent = data.badge_markdown;
  document.getElementById('widget-html').textContent = data.widget_html;
  
  return data;
}

Copy-to-Clipboard Feature

function copyToClipboard(elementId) {
  const text = document.getElementById(elementId).textContent;
  navigator.clipboard.writeText(text).then(() => {
    showToast('Copied to clipboard!');
  });
}

<div class="snippet-container">
  <h4>Markdown Badge</h4>
  <code id="badge-markdown"></code>
  <button onclick="copyToClipboard('badge-markdown')">Copy</button>
</div>

Custom Domain Support

If you have a custom domain configured, the snippets automatically use your custom domain:

{
  "status_page_url": "https://status.yourcompany.com",
  "badge_markdown": "[![Status](https://statuspage.me/badge/your-slug.svg)](https://status.yourcompany.com)",
  ...
}

Caching

• Responses are cached for ~5 minutes
• Safe to cache on your end
• Snippets update automatically if your domain changes

Plan Requirements

Note: The Markdown Snippets API requires Growth, Business, OSS Hero, or Enterprise plan.

Basic badge functionality is available on Pro plans, but this API endpoint requires advanced API access.

Error Responses

What’s Next?

• SVG Badge API for direct badge access
• Embed Status API for JSON data
• Live Widget guide for embedding