Sign in
monitors

Create monitor

Create a new monitoring endpoint

post/monitors

Request body

namestring required
descriptionstring
type'http' | 'ping' | 'pagespeed' | 'hardware' | 'docker' | 'port' | 'game' | 'grpc' | 'websocket' required
urlstring uri required
intervalinteger

Check interval in seconds

statusWindowSizeinteger
statusWindowThresholdinteger
isActiveboolean
ignoreTlsErrorsboolean
useAdvancedMatchingboolean
portinteger
notificationsstring[]

Array of notification IDs to associate with this monitor

secretstring
jsonPathstring
expectedValuestring
matchMethod'equal' | 'include' | 'regex' | ''
cpuAlertThresholdnumber
memoryAlertThresholdnumber
diskAlertThresholdnumber
tempAlertThresholdnumber
gameIdstring
grpcServiceNamestring
selectedDisksstring[]
groupstring nullable
geoCheckEnabledboolean
geoCheckLocationsstring[]
geoCheckIntervalinteger

Example request

{
  "name": "My Website Monitor",
  "description": "Monitors the main website homepage",
  "type": "http",
  "url": "https://example.com",
  "interval": 300
}

Response

Monitor created successfully

successboolean required
msgstring required

Example response

{
  "success": true,
  "msg": "Operation completed successfully",
  "data": {
    "_id": "64f123a456b789012c345def",
    "name": "My Website Monitor",
    "description": "Monitors the main website homepage",
    "url": "https://example.com",
    "interval": 300,
    "isActive": true
  }
}

Changes