Skip to main content
POST
/
api
/
v1
/
monitors
Create monitor
curl --request POST \
  --url https://app.larm.dev/api/v1/monitors \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "check_type": "<string>",
  "config": {},
  "interval_seconds": 123,
  "timeout_ms": 123,
  "confirm_down_minutes": 123,
  "confirm_up_minutes": 123,
  "confirm_down_after": 123,
  "confirm_up_after": 123,
  "enabled": true,
  "alert_channel_ids": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Marketing site",
    "check_type": "http",
    "enabled": true,
    "interval_seconds": 180,
    "timeout_ms": 10000,
    "confirm_down_minutes": 1,
    "confirm_up_minutes": 3,
    "config": {
      "url": "https://example.com",
      "method": "GET",
      "expected_status_codes": [200],
      "follow_redirects": true
    },
    "current_state": "pending",
    "alert_channel_ids": ["660e8400-e29b-41d4-a716-446655440000"],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.larm.dev/llms.txt

Use this file to discover all available pages before exploring further.

Requires monitors:read_write permission.
​
name
string
required
Monitor name (1–255 characters)
​
check_type
string
required
http, tcp, dns, heartbeat, or synthetic
​
config
object
required
Type-specific configuration. See Monitors for fields per type.
​
interval_seconds
integer
default:180
Check interval in seconds (minimum: 30)
​
timeout_ms
integer
default:10000
Timeout in milliseconds (range: 1000–30000)
​
confirm_down_minutes
integer
default:1
Minutes of consecutive failures before marking down (HTTP, TCP, DNS, heartbeat)
​
confirm_up_minutes
integer
default:3
Minutes of consecutive successes before marking recovered (HTTP, TCP, DNS, heartbeat)
​
confirm_down_after
integer
default:3
Consecutive failures before marking down (synthetic monitors only, range: 1–10)
​
confirm_up_after
integer
default:1
Consecutive passes before marking recovered (synthetic monitors only, range: 1–10)
​
enabled
boolean
default:true
Whether the monitor is active
​
alert_channel_ids
string[]
List of alert channel IDs to attach. If omitted, channels with default_for_new_monitors are linked automatically.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Marketing site",
    "check_type": "http",
    "enabled": true,
    "interval_seconds": 180,
    "timeout_ms": 10000,
    "confirm_down_minutes": 1,
    "confirm_up_minutes": 3,
    "config": {
      "url": "https://example.com",
      "method": "GET",
      "expected_status_codes": [200],
      "follow_redirects": true
    },
    "current_state": "pending",
    "alert_channel_ids": ["660e8400-e29b-41d4-a716-446655440000"],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}