StatusGator Octri Preview
POST/boards/{board_id}/ping_monitors

Create ping monitor

Create a new ping monitor for the specified board. Ping monitors allow you to monitor the uptime and connectivity of hosts by sending ICMP ping requests. You can configure various monitoring options including check intervals, timeout settings, and notification preferences.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 10 body fields
board_idstringrequired
Unique ID of the board
alert_any_locationbooleanoptional
Alert if any location down vs all locations down
check_intervalintegeroptional
Check interval in minutes (1-5)
Allowed:12345
check_regionsarray<string>optional
Monitoring regions
descriptionstringoptional
Optional description for the monitor
metadataobjectoptional
Key/value tags
monitor_group_idstringoptional
ID of the monitor group to assign this monitor to
namestringrequired
Display name for the monitor
retry_countintegeroptional
Number of retries before alerting
Allowed:0123
timeoutintegeroptional
Request timeout in seconds
Allowed:5153060
urlstringrequired
Hostname or IP address to monitor

4 status codes
201ping monitor created with monitor group
dataobjectoptional
successbooleanoptional
401unauthorized
403monitor limit reached
422validation errors
errorsarray<string>optional
successbooleanoptional

Error handling

A 401 is returned: unauthorized. A 403 is returned: monitor limit reached. A 422 is returned: validation errors.