Sign in

v1

latestOpenAPI 3.1.0AGPL-3.02026-07-17644498.1 KB
Monitors

Create a monitor

Create a new uptime or performance monitor.

post/api/monitors

Request body

namestring required
descriptionstring
type'http_request' | 'website' | 'ping_host' | 'port_check' | 'synthetic_test' required
targetstring

URL, host, or synthetic test target to monitor

frequencyMinutesinteger

Check interval in minutes

enabledboolean

Example request

{
  "name": "API Health Check",
  "frequencyMinutes": 5
}

Response

Monitor created

idstring uuid
organizationIdstring uuid nullable
projectIdstring uuid nullable
createdByUserIdstring uuid nullable
namestring
descriptionstring nullable
targetstring

URL, host, or synthetic test target being monitored

type'http_request' | 'website' | 'ping_host' | 'port_check' | 'synthetic_test'
status'up' | 'down' | 'paused' | 'pending' | 'maintenance' | 'error'
frequencyMinutesinteger

Check interval in minutes

enabledboolean
lastCheckAtstring date-time nullable
lastStatusChangeAtstring date-time nullable
mutedUntilstring date-time nullable
scheduledJobIdstring nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable