Documentation

Everything you need to integrate with Quismon's API and tools.

API Reference

Complete REST API documentation with OpenAPI 3.0 specification. Interactive docs for all endpoints.

Terraform Provider

Manage Quismon resources with Terraform. Define checks, notifications, and more as infrastructure as code. Full documentation with examples available on GitHub.

View Provider Docs

MCP Server

Model Context Protocol server for AI assistants. Connect Claude or other AI agents directly to your monitoring.

MCP Endpoint

Check Types

All supported check types and their execution models.

HTTP/HTTPS - Web endpoints, APIs
HTTP/3 - QUIC protocol endpoints
Ping - ICMP host availability
TCP - Port connectivity
DNS - Record queries & change detection
SSL - Certificate expiry & fingerprinting
Multi-step - Sequential workflows with variable extraction
Throughput - Bandwidth testing
SMTP/IMAP - Email delivery validation

Notification Channels

Configure alerts through multiple channels to reach the right people.

Email notifications
Slack webhooks
ntfy.sh push notifications
Custom webhooks

Monitoring Regions

31 locations across 6 continents via Vultr for true global visibility.

North America: New York, Los Angeles, Seattle, Dallas, Chicago, Miami, Atlanta, Toronto, Mexico City
Europe: Amsterdam, London, Manchester, Frankfurt, Paris, Madrid, Warsaw, Stockholm
Asia Pacific: Tokyo, Osaka, Seoul, Singapore, Mumbai, Delhi, Bangalore, Tel Aviv
Australia: Sydney, Melbourne
South America: São Paulo, Santiago
Africa: Johannesburg

Check Execution Models

Understanding how different check types execute.

Multi-step checks: All steps run sequentially on a single checker node. Variables and cookies flow between steps. Perfect for login flows and API chains.
Dependent checks: Independent checks that can trigger each other. Each runs from its own configured regions. Ideal for root cause analysis chains.
Simultaneous regions: All regions check at once for fast outage detection.
Staggered regions: Regions check in sequence to spread load and detect transient issues.

Inverted Checks

Alert when something shouldn't be accessible.

Alert if a port is open (should be closed)
Alert if a private page becomes public
Alert if a service responds when it shouldn't
Perfect for security posture monitoring

Expiring Checks

Temporary checks that auto-delete after a set duration.

Deployment verification checks
CI/CD pipeline monitoring
Incident investigation checks
A/B test and preview environment monitoring

Organization & User Management

Manage team members, roles, and permissions. Invite colleagues and control access levels.

Owner: Full access, billing, manage all members
Admin: Invite members, manage checks
Member: View and manage checks
Invite via Console or API: POST /v1/org/members

AI Quickstart

Point your AI assistant at Quismon and let it handle the setup.

Context you can share with your AI assistant:

Quismon is an API-first monitoring platform.

Key resources:
- API docs: https://docs.quismon.com
- Regions list: https://api.quismon.com/v1/regions
- MCP endpoint: https://mcp.quismon.com

Quick signup via API:
curl -X POST https://api.quismon.com/v1/auth/quick-signup \
  -H "Content-Type: application/json" \
  -d '{"email": "YOUR_EMAIL", "org_name": "YOUR_ORG"}'

Returns an api_key. Use it with:
- Authorization: Bearer <key> (preferred)
- X-API-Key: <key> (alternative)

Free tier: 1 region per check, 60s minimum interval
Check types: http, https, ping, tcp, dns, ssl, udp, multistep, throughput, smtp-imap, http3

What I want to monitor: [DESCRIBE YOUR SERVICES]

Self-Service Signup

No credit card or human approval needed. Your AI can create an account via API in seconds.

LLM-Friendly Docs

Our API docs and Terraform provider README are structured for easy AI comprehension.

Quick Start

Get started with Quismon in minutes.

1. Create an account

2. Create your first check

Use the console or API to create an HTTP check:

curl -X POST https://api.quismon.com/v1/checks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Website",
    "type": "https",
    "config": {
      "url": "https://example.com",
      "method": "GET",
      "expected_status": [200]
    },
    "interval_seconds": 60,
    "regions": ["eu-west-ams"]
  }'

3. Set up notifications

Create a notification channel to receive alerts:

curl -X POST https://api.quismon.com/v1/notification-channels \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Email",
    "type": "email",
    "config": {"email": "you@example.com"}
  }'

4. Monitor!

Your check is now running. View results in the console or query via API.

Terraform Example

Define your monitoring as code.

terraform {
  required_providers {
    quismon = {
      source  = "quismon/quismon"
      version = "~> 1.0"
    }
  }
}

# No API key needed for first run - use quismon_signup!
resource "quismon_signup" "main" {
  email    = "you@example.com"
  org_name = "My Company"
}

resource "quismon_check" "website" {
  name             = "Company Website"
  type             = "https"
  interval_seconds = 60
  regions          = ["eu-west-ams", "na-east-ewr"]
  enabled          = true

  config = {
    url             = "https://example.com"
    method          = "GET"
    expected_status = "200"
  }
}

resource "quismon_notification_channel" "slack" {
  name = "DevOps Slack"
  type = "slack"

  config = {
    webhook_url = var.slack_webhook_url
  }

  enabled = true
}

output "api_key" {
  value     = quismon_signup.main.api_key
  sensitive = true
}

Ready to start?

Get started for free. No credit card required.

Start Free API Docs