Sign in

v30

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-017419232.3 KB
monitors

Create a new monitor

post/monitors

Request body

_idstring
namestring required
type'http' | 'ping' | 'pagespeed' | 'hardware' | 'docker' | 'port' | 'game' | 'grpc' | 'websocket' | 'dns' | 'unknown' required
statusWindowSizenumber
statusWindowThresholdnumber
urlstring required
ignoreTlsErrorsboolean
useAdvancedMatchingboolean
portnumber
isActiveboolean
intervalnumber
cpuAlertThresholdnumber
memoryAlertThresholdnumber
diskAlertThresholdnumber
tempAlertThresholdnumber
notificationsstring[]
tagsstring[]
customUpCodesnumber[]
secretstring
method'GET' | 'HEAD'
strategy'desktop' | 'mobile'
selectedDisksstring[]
geoCheckEnabledboolean
geoCheckLocationsstring[]
geoCheckIntervalnumber
dnsServerstring
dnsRecordType'A' | 'AAAA' | 'CNAME' | 'MX' | 'TXT' | 'NS'

Response

Monitor created

successtrue required
msgstring required

Example response

{
  "data": {
    "_id": "65f1c2a4d8b9e0123456789a",
    "name": "Marketing site",
    "description": "Production marketing site monitored from the EU region",
    "type": "http",
    "url": "https://www.example.com",
    "port": 443,
    "isActive": true,
    "interval": 60000,
    "status": "up",
    "statusWindowSize": 5,
    "statusWindowThreshold": 3,
    "ignoreTlsErrors": false,
    "useAdvancedMatching": false,
    "notifications": [
      "65f1c2a4d8b9e0123456789b"
    ],
    "cpuAlertThreshold": 90,
    "memoryAlertThreshold": 90,
    "diskAlertThreshold": 90,
    "tempAlertThreshold": 80,
    "selectedDisks": [],
    "geoCheckEnabled": false,
    "geoCheckLocations": [],
    "geoCheckInterval": 300000,
    "teamId": "65f1c2a4d8b9e01234567890",
    "userId": "65f1c2a4d8b9e01234567891",
    "createdAt": "2026-04-01T10:00:00.000Z",
    "updatedAt": "2026-04-15T14:30:00.000Z"
  }
}