REST API Documentation — UptimeClaw Developer Docs

Authentication

All API requests require a Bearer token in the Authorization header. Generate API keys from your dashboard under Settings → API Keys.

curl https://uptimeclaw.com/api/v1/monitors \
  -H "Authorization: Bearer uc_live_abc123def456"
        

API keys come in two types:

Type	Prefix	Access
Live	`uc_live_`	Full read/write access
Read-only	`uc_read_`	Read access only — cannot create, update, or delete

Base URL

All endpoints are relative to:

https://uptimeclaw.com/api/v1

All responses return JSON with Content-Type: application/json.

Errors

The API returns standard HTTP status codes. Error responses include a JSON body with error and message fields.

// 401 Unauthorized
{
  "error": "unauthorized",
  "message": "Invalid or expired API key"
}
        

Code	Meaning
`200`	Success
`201`	Created
`400`	Bad request — check parameters
`401`	Unauthorized — invalid API key
`404`	Not found
`429`	Rate limited — 100 requests/min
`500`	Server error

List monitors

Returns all monitors for your account, ordered by creation date.

GET /monitors

Query parameters

Parameter	Type	Description
`status`	string	Filter by status: `up`, `down`, `paused`
`type`	string	Filter by type: `http`, `keyword`, `ping`, `port`
`page`	integer	Page number (default: 1)
`per_page`	integer	Results per page (default: 25, max: 100)

# List all monitors
curl https://uptimeclaw.com/api/v1/monitors \
  -H "Authorization: Bearer uc_live_***"

# Response
{
  "data": [
    {
      "id": 1842,
      "name": "Production API",
      "url": "https://api.example.com/health",
      "type": "http",
      "status": "up",
      "interval": 60,
      "last_checked_at": "2026-03-22T21:14:00Z",
      "response_time": 142
    }
  ],
  "meta": { "total": 47, "page": 1, "per_page": 25 }
}
        

Create monitor

Create a new monitor. It starts checking immediately after creation.

POST /monitors

Body parameters

Parameter	Type	Required	Description
`url`	string	Yes	URL or hostname to monitor
`name`	string	No	Display name (defaults to URL)
`type`	string	No	`http`, `keyword`, `ping`, `port` (default: http)
`interval`	integer	No	Seconds between checks (default: plan minimum)
`alerts`	array	No	Alert channels: `email`, `whatsapp`, `webhook`
`keyword`	string	Conditional	Required if type is `keyword`
`port`	integer	Conditional	Required if type is `port`

curl -X POST https://uptimeclaw.com/api/v1/monitors \
  -H "Authorization: Bearer uc_live_***" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://api.example.com",
    "name": "Production API",
    "type": "http",
    "interval": 60,
    "alerts": ["whatsapp", "email"]
  }'

# 201 Created
{
  "id": 1843,
  "status": "active",
  "next_check_at": "2026-03-22T21:15:00Z"
}
        

Get monitor

Retrieve a single monitor with full details including recent checks.

GET /monitors/:id

Update monitor

Update an existing monitor's configuration. Only include the fields you want to change.

PUT /monitors/:id

Delete monitor

Permanently delete a monitor and all its historical data. This action cannot be undone.

DELETE /monitors/:id

Alert channels

List all configured alert channels for your account.

GET /alerts/channels

Configure alerts

Update alert settings for a specific monitor.

PUT /monitors/:id/alerts

curl -X PUT https://uptimeclaw.com/api/v1/monitors/1842/alerts \
  -H "Authorization: Bearer uc_live_***" \
  -d '{
    "channels": ["whatsapp", "email", "webhook"],
    "webhook_url": "https://hooks.slack.com/services/T00/B00/xxx",
    "escalation_minutes": 5
  }'
        

List status pages

Retrieve all status pages for your account.

GET /status-pages

Create status page

Create a new public or private status page linked to your monitors.

POST /status-pages

Webhook events

UptimeClaw sends webhook events for monitor state changes. Configure webhook URLs per monitor or globally.

Event	Trigger
`monitor.down`	Monitor detects downtime
`monitor.up`	Monitor recovers from downtime
`monitor.degraded`	Response time exceeds threshold
`ssl.expiring`	SSL certificate expiring within 30 days

Webhook payloads

All webhooks are sent as POST requests with a JSON body and a X-UptimeClaw-Signature header for verification.

// monitor.down payload
{
  "event": "monitor.down",
  "timestamp": "2026-03-22T21:14:00Z",
  "monitor": {
    "id": 1842,
    "name": "Production API",
    "url": "https://api.example.com/health",
    "status_code": 503,
    "response_time": null,
    "region": "us-east-1"
  }
}
        

Build with theUptimeClaw API.