Getting Started

Go from creating an account to having your first monitor on a status page in under 5 minutes.

Using the API

Automate monitor creation with our REST API. Perfect for CI/CD pipelines, infrastructure-as-code, or building custom integrations.

1 Get your API key

Go to Settings → API Keys and create a new key. Copy it immediately — it's only shown once!

2 Create a monitor

Use the POST /api/v1/monitors endpoint to create monitors programmatically.

curl (Linux/macOS)

curl -X POST https://api.okstatus.dev/api/v1/monitors \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "http",
    "name": "Production API",
    "check_config": {
      "interval_secs": 300,
      "check": {
        "type": "http",
        "url": "https://api.yoursite.com/health",
        "method": "get",
        "port": 443,
        "timeout_ms": 5000,
        "follow_redirects": true,
        "allow_insecure": false
      }
    },
    "show_on_status_page": true
  }'

PowerShell (Windows)

$headers = @{
    "x-api-key" = "YOUR_API_KEY"
    "Content-Type" = "application/json"
}

$body = @{
    kind = "http"
    name = "Production API"
    check_config = @{
        interval_secs = 300
        check = @{
            type = "http"
            url = "https://api.yoursite.com/health"
            method = "get"
            port = 443
            timeout_ms = 5000
            follow_redirects = $true
            allow_insecure = $false
        }
    }
    show_on_status_page = $true
} | ConvertTo-Json -Depth 10

Invoke-RestMethod -Uri "https://api.okstatus.dev/api/v1/monitors" `
    -Method POST `
    -Headers $headers `
    -Body $body

3 List your monitors

Verify your monitor was created by listing all monitors.

curl

curl -H "x-api-key: YOUR_API_KEY" https://api.okstatus.dev/api/v1/monitors

PowerShell

Invoke-RestMethod -Uri "https://api.okstatus.dev/api/v1/monitors" -Headers @{"x-api-key" = "YOUR_API_KEY"}

Monitor Types Reference

http

HTTP/HTTPS endpoint checks with status codes and latency

tcp

TCP port connectivity checks

ping

ICMP ping for host reachability

dns

DNS resolution checks

certexpiry

SSL/TLS certificate expiration monitoring

Full API Reference

Explore all endpoints, request schemas, and response formats in our interactive API documentation.

View API Docs

Using the App

1 Create your account

Head to the registration page and sign up with your email. You'll get a free workspace with up to 5 monitors.

Tip: Your workspace slug becomes your public status page URL (e.g., status.okstatus.dev/your-company).

2 Create your first monitor

From your dashboard, click "Add Monitor" and configure:

Type: HTTP, TCP, Ping, DNS, or Certificate Expiry
Name: A friendly name like "Production API"
Target: The URL or host to monitor
Interval: How often to check (free plan: 5 min minimum)

Example: To monitor your API health endpoint, select HTTP, enter https://api.yoursite.com/health, and set a 5-minute interval.

3 Enable on status page

Toggle "Show on status page" when creating your monitor. This makes it visible on your public status page.

Your status page is live at: https://status.okstatus.dev/your-slug

4 Configure alerts (optional)

In the monitor settings, configure when to be notified:

Email: Get notified at your account email
Webhook: POST to your endpoint when status changes
Incident settings: Configure how many failures trigger an incident

Create your free account