Skip to main content
POST
Create Uptime Monitor
The checks array holds the health-check cards a run grades. Each check is an object:
The three template checks (checkType of connection, agent_malfunction, or latency) have isTemplate: true. A user-added check has isTemplate: false and points at a custom metric (customMetricId, with a condition of data_type, operator, and comparison_value) or a Digital Human (digitalHumanId). A digitalHumanId check swaps the default caller for that Digital Human — see Custom caller. It only picks who places the probe, so at least one enabled check must still carry a checkType or customMetricId, or the request is rejected with a 400. The notifications object accepts any of:

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Body

application/json
agent_id
integer
required
frequency
string
default:5m
active_window
ActiveWindow · object | null

Days/hours the monitor may run, e.g. {"days": ["monday"], "start_time": "09:00", "end_time": "17:00", "timezone": "America/Los_Angeles"}. Null runs it around the clock.

checks
Checks · object[]
notifications
Notifications · object
enabled
boolean
default:true
start_at
string | null

ISO 8601 first-check time; defaults to now().

Response

Successful Response