Skip to content

Documentation

API docs your developers will love.

Build an API documentation platform with interactive references, auto-generated code samples, and comprehensive guides. Ship developer documentation that drives adoption and reduces support burden.

docs / api / monitors
  • POSTmihari.io/v1/monitors
  • PATCHmihari.io/v1/monitors/:id
  • DELETEmihari.io/v1/monitors/:id
  • GETmihari.io/v1/incidents
  • GETmihari.io/v1/heartbeats
  • POSTmihari.io/v1/heartbeats/:id/ping
  • Interactive API reference

    Generated from your OpenAPI or Swagger specification, with a Try it console for live requests.

  • Code samples

    Every endpoint ships with copy-paste code that stays synchronized with your API specification.

  • Guides & tutorials

    Quickstarts and walkthroughs with Markdown, code snippets, diagrams and images.

  • Customization & branding

    Your colors, typography, logo and favicon, on your own custom domain with automatic SSL.

  • Changelogs

    Keep developers informed as your API evolves, with structured entries tagged Added, Improved and Fixed.

  • Search & analytics

    Full-text search across your pages and endpoints, and page views to find your most visited docs.

Interactive API reference

Explore endpoints with live requests.

Ditch static documentation that quickly goes stale. Mihari generates an interactive reference from your OpenAPI or Swagger specification: developers read parameter descriptions, see type information, and fire real API calls without leaving the browser.

  • Auto-generated from OpenAPI/Swagger specifications
  • In-browser "Try it" console for sending live API requests
  • Request and response examples for every endpoint and status code
API reference · Monitors
  • GET/api/v2/monitors
  • POST/api/v2/monitors
  • GET/api/v2/monitors/{id}
  • PATCH/api/v2/monitors/{id}
  • DELETE/api/v2/monitors/{id}
POST/api/v2/monitors

Request body

{
"url": "https://api.acme.com",
"type": "http",
"interval": 60
}

201 Created

{
"id": 847,
"url": "https://api.acme.com",
"status": "active"
}

Guides & tutorials

Comprehensive guides that onboard fast.

API references alone aren't enough. Create rich guides, tutorials, and quickstart walkthroughs with Markdown, embedded code snippets, diagrams, and images, plus a table of contents and contextual links that help developers find answers without searching.

  • Rich Markdown editor with images and embedded media
  • Table of contents and breadcrumb navigation
  • Step-by-step tutorial format with numbered sections and code blocks
  • Cross-link between guides, API reference, and changelog entries
Guides · Getting started

Guides Getting started

Setting up your first monitor

This guide walks you through creating your first uptime monitor in under five minutes. You'll learn how to configure an HTTP check, set up alerting, and view your first response time metrics.

  1. 1Create your projectNavigate to the dashboard and click "New Project" to set up your monitoring workspace.
  2. 2Add a monitorDefine the endpoint URL, check interval, and expected status code for your HTTP monitor.

Customization & branding

Your brand, your docs experience.

Make your developer documentation a seamless extension of your product. Your documentation portal looks and feels like a first-party product, not a third-party hosted page.

  • Colors, typography, logo, and favicon
  • Your own custom domain with automatic SSL
  • Light and dark themes, and the navigation structure you choose
  • Custom CSS for pixel-perfect branding
  • White-label options for complete brand consistency
Appearance settings
Logo
acme-logo.svg uploaded
Brand palette
Custom domain
docs.acme.comSSL active
Theme

In the product

Our own documentation runs on Mihari

The user guide at doc.mihari.io is published with the documentation product described on this page.

doc.mihari.io / heartbeats-recipes
The Mihari user guide on doc.mihari.io: the Heartbeat recipes page at its Shell and curl section, with curl and bash examples, the guide's sidebar navigation and an on-this-page outline that follows the current heading
LiveMihari's own documentation, published with Mihari.

Ship docs developers love.

Create an API documentation platform that delights developers and drives adoption. Interactive and always up to date. Free to get started.