API Documentation

List all your monitored endpoint subscriptions.

Query: ?active=true|false (default: true)

// Response
{
  "endpoints": [
    {
      "id": "sub_abc123",
      "name": "Stripe Charges",
      "url": "https://api.stripe.com/v1/charges",
      "method": "GET",
      "endpointType": "rest",
      "pollIntervalMinutes": 60,
      "isActive": true,
      "tags": ["payments", "critical"],
      "driftCount": 2,
      "lastCheckedAt": "2026-03-16T10:00:00Z",
      "lastStatusCode": 200
    }
  ],
  "count": 1
}

Subscribe to a new API endpoint or MCP server for monitoring.

// REST endpoint
{
  "name": "Stripe Charges",
  "url": "https://api.stripe.com/v1/charges",
  "method": "GET",
  "endpointType": "rest",
  "headers": { "Authorization": "Bearer sk_..." },
  "requestBody": null,
  "pollIntervalMinutes": 60,
  "tags": ["payments"]
}

// MCP server
{
  "name": "My MCP Server",
  "url": "https://mcp.example.com/mcp",
  "endpointType": "mcp",
  "headers": { "Authorization": "Bearer token" },
  "pollIntervalMinutes": 60,
  "tags": ["ai-tools"]
}

// Response (201)
{ "id": "sub_abc123", "name": "Stripe Charges", ... }

For MCP servers, method is automatically set to POST. The initial poll connects via MCP protocol and captures the tool catalog as the baseline schema. MCP response includes mcpServerInfo with serverName, protocolVersion, toolCount, and lastToolNames.

Get a single endpoint subscription with full details.

Update subscription settings. URL, method, and headers are immutable after creation.

// Request body (all fields optional)
{
  "name": "Updated Name",
  "pollIntervalMinutes": 120,
  "tags": ["updated-tag"],
  "isActive": false
}

Unsubscribe from an endpoint. If no other subscribers remain, the watched URL is also removed.

Test an endpoint connection without saving. Supports both REST and MCP endpoint types.

// REST test
{
  "url": "https://api.example.com/data",
  "endpointType": "rest",
  "method": "GET",
  "headers": {}
}

// REST response
{
  "success": true,
  "statusCode": 200,
  "responseTimeMs": 142,
  "isJson": true,
  "fieldCount": 12
}

// MCP test
{
  "url": "https://mcp.example.com/mcp",
  "endpointType": "mcp",
  "headers": { "Authorization": "Bearer token" }
}

// MCP response
{
  "success": true,
  "endpointType": "mcp",
  "responseTimeMs": 230,
  "serverName": "my-mcp-server",
  "protocolVersion": "2025-03-26",
  "toolCount": 5,
  "toolNames": ["search", "create", "update", "delete", "list"]
}

Manually re-poll the endpoint and update the baseline schema.

Browse the public endpoint library. Discover popular APIs already monitored by other users.

Query: ?q=search&limit=100&offset=0

Get drift event history for an endpoint.

Query: ?limit=50&severity=breaking|warning|info

// Response
{
  "endpointId": "sub_abc123",
  "endpointName": "Stripe Charges",
  "events": [
    {
      "id": "drift_xyz",
      "severity": "breaking",
      "changes": [
        { "path": "data.currency", "type": "removed" },
        { "path": "data.amount", "type": "type_change",
          "from": "number", "to": "string" }
      ],
      "detectedAt": "2026-03-16T10:00:00Z"
    }
  ],
  "count": 1
}

Acknowledge or resolve a drift event.

// Request body
{
  "action": "acknowledge"  // or "resolve"
}

// Response
{ "success": true, "action": "acknowledge", "driftId": "drift_xyz" }

Get JSON-RPC error code breakdown for MCP endpoints. Shows error distribution and state transitions.

Query: ?range=24h|7d|30d (default: 7d). Only available for MCP endpoint types.

// Response
{
  "range": "7d",
  "totalPolls": 168,
  "successCount": 162,
  "failureCount": 6,
  "errorCodeDistribution": { "-32601": 3, "-32603": 1 },
  "connectionErrors": { "Timeout": 2 },
  "transitions": [
    { "from": "success", "to": "-32601", "at": "2026-03-16T10:00:00Z" }
  ]
}

Get drift alert configuration for an endpoint (enabled status and minimum severity threshold).

Toggle drift alerts on/off and set the minimum severity that triggers a notification.

// Request body
{
  "driftAlertsEnabled": true,
  "driftAlertMinSeverity": "warning"  // "info" | "warning" | "breaking"
}

Get poll history with response time stats for charting.

Query: ?range=24h|7d|30d (default: 7d)

// Response
{
  "history": [
    { "polledAt": "2026-03-16T10:00:00Z",
      "statusCode": 200, "responseTimeMs": 142, "success": true }
  ],
  "stats": {
    "min": 98, "max": 312, "avg": 156,
    "p50": 142, "p95": 285, "p99": 310
  },
  "totalPolls": 168,
  "successfulPolls": 167,
  "failedPolls": 1
}

Get 30-day uptime percentage with daily breakdown.

// Response
{
  "uptimePercent": 99.4,
  "totalPolls": 720,
  "successfulPolls": 716,
  "failedPolls": 4,
  "dailyBuckets": [
    { "date": "2026-03-16", "total": 24, "success": 24 }
  ]
}

Get SSL certificate status including issuer and expiry date.

// Response
{
  "sslExpiresAt": "2026-09-15T00:00:00Z",
  "sslIssuer": "Let's Encrypt Authority X3",
  "sslCheckedAt": "2026-03-16T10:00:00Z"
}

Get status code distribution over time.

Query: ?range=24h|7d|30d (default: 7d)

List alert destination configurations. Optionally filter by endpoint.

Query: ?endpointId=sub_abc123 (optional — returns endpoint-specific and global alerts separately)

Create a new alert destination (email or webhook).

// Email alert
{
  "type": "email",
  "config": { "to": "you@example.com" },
  "minSeverity": "warning",          // optional: "info" | "warning" | "breaking"
  "endpointId": "sub_abc123"         // optional (global if omitted)
}

// Webhook alert
{
  "type": "webhook",
  "config": { "url": "https://your-webhook-endpoint.com/hook" }
}

Update alert config or toggle active/inactive.

Remove an alert destination.

List metric alert rules for a watched URL.

Query: ?watchedUrlId=uuid (required), &metric=response_time (optional filter)

Create a metric alert rule.

// Request body
{
  "watchedUrlId": "uuid-of-watched-url",
  "metric": "response_time",
  "operator": "gt",
  "threshold": 2000,
  "consecutiveIntervals": 3,
  "notifyOnResolve": false
}

// Supported metrics: response_time, status_code, ssl_expiry,
//                    response_size, availability
// Supported operators: gt, lt, eq, neq

Replace an existing metric alert rule.

Delete a metric alert rule.

Get the current state of a metric alert rule (status, streak, acknowledgement).

Acknowledge a fired alert. Silences repeat notifications until the condition heals and re-fires.

Manually resolve a metric alert. Resets the alert state entirely (streak, acknowledgement, and status).

List alert event history for a watched URL. Shows fired, acknowledged, and resolved events.

Query: ?watchedUrlId=uuid (required), &limit=20&offset=0

// Response
{
  "events": [
    {
      "id": "evt_abc",
      "type": "fired",
      "metric": "response_time",
      "threshold": 2000,
      "actualValue": 3200,
      "supersededBy": null,
      "createdAt": "2026-03-16T10:00:00Z"
    }
  ],
  "count": 1
}

Get currently active (unresolved) alerts for an endpoint.

List all alert events across the current organization. Includes both drift and metric alert events with endpoint context.

Query: ?limit=30&offset=0&type=drift|metric&search=url-fragment

Get status page data for an organization by its slug. Public if the org has enabled public status pages, otherwise requires org membership.

// Response
{
  "org": { "name": "My Team", "slug": "my-team", "description": "..." },
  "isPublic": true,
  "overallStatus": "operational",  // "operational" | "degraded" | "down" | "unknown"
  "endpoints": [
    {
      "name": "Stripe API",
      "currentStatus": "operational",
      "uptimePercent": 99.4,
      "avgResponseTimeMs": 156,
      "lastCheckedAt": "2026-03-16T10:00:00Z",
      "sslStatus": "valid",  // "valid" | "warning" | "critical" | "expired" | null
      "dailyBuckets": [
        { "date": "2026-03-16", "total": 24, "success": 24 }
      ]
    }
  ],
  "generatedAt": "2026-03-16T10:05:00Z"
}

List organizations you belong to.

Create a new organization.

// Request body
{
  "name": "My Team",
  "slug": "my-team"   // lowercase alphanumeric with hyphens
}

Update organization name or slug.

List organization members and their roles.

Invite a member to the organization.

List folders for the active organization.

Create a folder to organize endpoints.

// Request body
{
  "name": "Production APIs",
  "color": "#4CAF50"    // optional
}

Update a folder name or color.

// Request body
{ "id": "folder-uuid", "name": "Updated Name" }

Delete a folder. Endpoints in the folder are unassigned, not deleted.

// Request body
{ "id": "folder-uuid" }

Check if you have an API key generated.

Generate or regenerate your API key. Returns the raw key (store it securely — it cannot be retrieved later).

Revoke your current API key.

Get your current plan, limits, and usage.

// Response
{
  "plan": "starter",
  "limits": {
    "maxEndpoints": 25,
    "minPollIntervalMinutes": 60
  },
  "usage": { "endpoints": 8 }
}

See a pre-built schema drift example (Stripe-like charge object). No authentication required.

Compare two JSON objects for schema differences. No authentication required.

// Request body
{
  "before": { "id": 1, "name": "Alice", "active": true },
  "after": { "id": "1", "name": "Alice", "role": "admin" }
}

// Response
{
  "drift": {
    "changes": [
      { "path": "id", "type": "type_change", "from": "number", "to": "string" },
      { "path": "active", "type": "removed" },
      { "path": "role", "type": "added" }
    ],
    "summary": { "added": 1, "removed": 1, "typeChanges": 1 }
  }
}

A demo endpoint that rotates its schema every 6 hours. Monitor this to see drift detection in action.