Skip to main content
POST
/
heartbeat
/
{monitorId}
curl -X POST "https://kodostatus.com/api/heartbeat/hb_abc123" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "up",
    "response_time_ms": 1523,
    "message": "Backup completed successfully"
  }'

{
  "success": true,
  "recorded_at": "2024-01-15T10:30:00Z",
  "monitor_status": "up"
}
This endpoint requires API key authentication via the X-API-Key or Authorization: Bearer header.

​
Path Parameters

​
monitorId
string
required
The heartbeat monitor ID

​
Body Parameters

​
status
string
default:"up"
Status to report: up, down, degraded
​
response_time_ms
integer
Execution time in milliseconds
​
message
string
Optional status message

​
Response

​
success
boolean
Whether the heartbeat was recorded
​
recorded_at
string
ISO 8601 timestamp
​
monitor_status
string
Current monitor status
curl -X POST "https://kodostatus.com/api/heartbeat/hb_abc123" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "up",
    "response_time_ms": 1523,
    "message": "Backup completed successfully"
  }'

{
  "success": true,
  "recorded_at": "2024-01-15T10:30:00Z",
  "monitor_status": "up"
}