Skip to main content
POST
/
uptime
/
monitors
/
create
Uptime Monitors
curl --request POST \
  --url https://api.example.com/uptime/monitors/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "websiteId": "<string>",
  "url": "<string>",
  "interval": "<string>",
  "timeout": 123,
  "cacheBust": true,
  "jsonParsingConfig": {}
}
'
{
  "id": "<string>",
  "websiteId": "<string>",
  "url": "<string>",
  "interval": "<string>",
  "status": "<string>",
  "createdAt": "<string>"
}

Overview

Uptime monitoring checks your endpoints at regular intervals and tracks:
  • HTTP status codes
  • Response time (TTFB and total)
  • SSL certificate validity and expiration
  • Uptime percentage
  • Incident history

Create Monitor

Creates a new uptime monitoring schedule.

Request Body

websiteId
string
required
Website ID to associate monitor with
url
string
required
URL to monitor (must be absolute HTTP/HTTPS URL)
interval
string
required
Check interval: 1m, 5m, 15m, 30m, 1h, 6h, 12h, 24h
timeout
number
Request timeout in milliseconds (default: 30000)
cacheBust
boolean
Add cache-busting query parameter to requests (default: false)
jsonParsingConfig
object
JSON response parsing configuration for validating API responses

Example Request

curl -X POST https://api.databuddy.cc/uptime/monitors/create \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "websiteId": "web_xyz789",
    "url": "https://example.com",
    "interval": "5m",
    "timeout": 10000,
    "cacheBust": true
  }'

Response

id
string
Monitor schedule ID
websiteId
string
Associated website ID
url
string
Monitored URL
interval
string
Check interval
status
string
Monitor status: active, paused, or stopped
createdAt
string
ISO 8601 timestamp of creation
{
  "id": "sched_abc123",
  "websiteId": "web_xyz789",
  "url": "https://example.com",
  "interval": "5m",
  "timeout": 10000,
  "cacheBust": true,
  "status": "active",
  "createdAt": "2024-03-01T17:30:00Z"
}

List Monitors

Retrieve all uptime monitors for a website.
curl -X POST https://api.databuddy.cc/uptime/monitors/list \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "websiteId": "web_xyz789"
  }'

Update Monitor

Update an existing monitor’s configuration.
curl -X POST https://api.databuddy.cc/uptime/monitors/update \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "sched_abc123",
    "interval": "15m",
    "timeout": 15000
  }'

Delete Monitor

Stop and delete an uptime monitor.
curl -X POST https://api.databuddy.cc/uptime/monitors/delete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "sched_abc123"
  }'

Build docs developers (and LLMs) love