API Documentation

curl -H "Authorization: Bearer mum_your_key" \
  https://myupmonitor.com/api/monitors

{
  "name": "CI/CD Read-Only",
  "scopes": ["monitors:read", "incidents:read"]
}

// Response (raw key shown once):
{
  "key": { "id": "uuid", "name": "CI/CD Read-Only", "scopes": ["monitors:read", "incidents:read"] },
  "rawKey": "mum_..."
}

// Response
[
  {
    "id": "uuid",
    "website": "https://example.com",
    "check_type": "http",
    "interval_seconds": 60,
    "active": true,
    "last_status": 200,
    "uptime_24h": 99.95,
    "avg_response_ms": 245
  }
]

curl -X POST /api/monitors \
  -H "Authorization: Bearer mum_key" \
  -H "Content-Type: application/json" \
  -d '{"website":"https://example.com","check_type":"http","interval_seconds":60}'

// Response
{
  "uptime_percent": 99.95,
  "avg_response_ms": 245,
  "total_checks": 1440,
  "incidents": 1,
  "history": [
    { "timestamp": "2026-03-25T10:00:00Z", "status": 200, "response_ms": 230, "region": "us-east" }
  ]
}

{
  "url": "example.com",
  "check_type": "dns",
  "dns_record_type": "A",
  "dns_expected_value": "93.184.216.34",
  "interval_seconds": 600
}

{
  "url": "https://example.com",
  "check_type": "http",
  "http_keyword": "Welcome",
  "http_keyword_negate": false,
  "response_time_threshold_ms": 2000,
  "interval_seconds": 300
}

// api_check_steps is a JSON string containing an array of steps:
// Each step: name, method, url, headers, body, assertions, extract
//
// Step fields:
//   assertions: [{type: "status", value: "200"},
//                {type: "body_contains", value: "ok"},
//                {type: "json_path", path: "data.id", value: "123"}]
//   extract: {"token": "data.access_token"} (dot-notation JSON path)
//
// Variables from extract are available in later steps as {{token}}

{
  "name": "Production Alerts",
  "steps": [
    { "delayMinutes": 0, "channelIds": ["slack-channel-id"] },
    { "delayMinutes": 5, "channelIds": ["pagerduty-channel-id"] },
    { "delayMinutes": 15, "channelIds": ["email-channel-id"] }
  ]
}

{
  "monitor_id": "uuid",
  "title": "API degradation",
  "status": "investigating"
}

{
  "status": "identified",  // investigating | identified | monitoring | resolved
  "message": "Root cause identified — deploying fix"
}

{
  "name": "Acme Status",
  "slug": "acme",
  "custom_domain": "status.acme.com"  // optional, Business+ plans
}

// Slack
{ "name": "Ops Slack", "type": "slack", "config": { "webhook_url": "https://hooks.slack.com/..." } }

// Discord
{ "name": "Alerts", "type": "discord", "config": { "webhook_url": "https://discord.com/api/webhooks/..." } }

// Webhook
{ "name": "Custom", "type": "webhook", "config": { "url": "https://example.com/hook", "secret": "hmac_secret" } }

# Add to your crontab:
*/5 * * * * curl -fsS -o /dev/null https://myupmonitor.com/api/heartbeat/your_token_here

# Or from a script:
curl -X POST https://myupmonitor.com/api/heartbeat/your_token_here

{
  "url": "Nightly Backup Job",
  "check_type": "heartbeat",
  "interval_seconds": 86400,
  "heartbeat_grace_minutes": 30
}

// Response includes heartbeat_token:
{
  "monitor": {
    "id": "uuid",
    "heartbeat_token": "a1b2c3..."  // Use this in your ping URL
  }
}

const crypto = require('crypto');

function verifyWebhook(body, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(body)
    .digest('hex');
  return `sha256=${expected}` === signature;
}

// In your handler:
const sig = req.headers['x-signature-256'];
if (!verifyWebhook(rawBody, sig, 'your_secret')) {
  return res.status(401).send('Invalid signature');
}

// Response
{ "tags": ["production", "api", "web", "database", "us-east"] }

// Response
{
  "score": 87,
  "label": "Good",
  "components": {
    "uptime": 38,        // max 40
    "responseTime": 25,  // max 30
    "incidents": 16,     // max 20
    "ssl": 8             // max 10
  },
  "trend": [
    { "date": "2026-03-08", "score": 82 },
    { "date": "2026-03-09", "score": 85 }
  ]
}

// Response
{
  "regions": [
    {
      "region": "eu",
      "avg_ms": 245, "min_ms": 120, "max_ms": 890,
      "p95_ms": 520, "check_count": 1440
    },
    {
      "region": "us-east",
      "avg_ms": 180, "min_ms": 95, "max_ms": 650,
      "p95_ms": 380, "check_count": 1440
    }
  ],
  "hourly": [
    { "hour": "2026-04-07T10:00:00Z", "region": "eu", "avg_ms": 240 }
  ]
}

// Response
{
  "nodes": [
    { "id": "uuid", "label": "api.example.com", "checkType": "http", "status": "up", "dependsOn": null },
    { "id": "uuid2", "label": "web.example.com", "checkType": "http", "status": "up", "dependsOn": "uuid" }
  ],
  "edges": [
    { "from": "uuid", "to": "uuid2" }
  ]
}

// Request
{
  "monitors": [
    { "url": "https://api.example.com", "check_type": "http", "interval_seconds": 60 },
    { "url": "https://web.example.com", "check_type": "ssl", "group_name": "Production" }
  ]
}

// Response
{
  "total": 2, "created": 2, "skipped": 0,
  "results": [
    { "url": "https://api.example.com", "status": "created" },
    { "url": "https://web.example.com", "status": "created" }
  ]
}

// Response
{
  "deliveries": [
    {
      "id": "uuid",
      "monitorName": "api.example.com",
      "alertType": "down",
      "status": "delivered",
      "attempts": 1,
      "lastError": null,
      "createdAt": "2026-04-07T10:00:00Z"
    },
    {
      "id": "uuid2",
      "monitorName": "db.example.com",
      "alertType": "down",
      "status": "failed",
      "attempts": 3,
      "lastError": "slack returned status 500",
      "createdAt": "2026-04-07T09:30:00Z"
    }
  ]
}

// Request
{
  "url": "https://your-server.com/webhooks/mum",
  "events_filter": ["monitor.created", "incident.opened"]  // null = all events
}

// Response — secret auto-generated for HMAC signing
{
  "webhook": {
    "id": "uuid",
    "url": "https://your-server.com/webhooks/mum",
    "secret": "a1b2c3...",
    "active": true,
    "eventsFilter": ["monitor.created", "incident.opened"]
  }
}

// Downloads JSON archive with:
// monitors, incidents, notification channels (secrets redacted),
// status pages, teams, API keys, daily stats,
// check history (30 days), audit log
// Rate limited: 1 per 10 minutes

// Response
{
  "requestsByKey": [
    { "keyId": "uuid", "keyName": "CI/CD", "totalRequests": 1234, "rateLimitHits": 2 }
  ],
  "requestsOverTime": [
    { "date": "2026-04-06", "requests": 450, "rateLimitHits": 0 }
  ],
  "topEndpoints": [
    { "endpoint": "/api/monitors", "method": "GET", "count": 800 }
  ]
}

{ "label": "deployed v2.3", "monitor_ids": ["uuid1", "uuid2"], "source": "api" }
// monitor_ids: null = all monitors. source: "manual", "api", "cli"

// Response — sorted by days remaining (most urgent first)
{ "certificates": [
  { "domain": "api.example.com", "issuer": "Let's Encrypt", "validUntil": "2026-07-15",
    "daysRemaining": 45, "status": "ok" }
] }

{ "runs": [{ "id": "uuid", "pagesCrawled": 87, "issuesFound": 3, "status": "completed" }],
  "issues": [
    { "sourceUrl": "https://example.com/about", "targetUrl": "https://example.com/old-page",
      "statusCode": 404, "issueType": "broken" }
  ] }

{
  "slaTarget": 99.9, "period": "monthly",
  "allowedDowntimeMinutes": 43.2, "usedDowntimeMinutes": 30.1,
  "remainingMinutes": 13.1, "consumptionPercent": 69.7,
  "status": "healthy"
}

{ "schedules": [
  { "id": "uuid", "name": "Primary", "currentOnCall": "alice@co.com",
    "overrideActive": false }
] }

// Response
{
  "entries": [
    {
      "id": "uuid",
      "title": "Percentile alerting (p95/p99)",
      "description": "Catch tail latency that averages hide.",
      "category": "feature",
      "publishedAt": "2026-04-07T12:00:00Z"
    }
  ]
}