StatusGator Octri Preview
PATCH/boards/{board_id}/custom_monitors/{id}

Update a custom monitor

Updates an existing custom monitor on a board. Supply any combination of name, description, metadata, and monitor_group_id to change those properties. Set monitor_group_id to null to remove the monitor from its group.

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

2 parameters · 4 body fields
board_idstringrequired
The unique ID of the board containing the custom monitor.
idstringrequired
The unique ID of the custom monitor to update.

Custom monitor properties to update; include the fields you want to change.

descriptionstringoptional
Description for the monitor
metadataobjectoptional
Key/value tags
monitor_group_idstringoptional
ID of the monitor group to assign this monitor to (set to null to remove from group)
namestringoptional
Display name for the monitor

3 status codes
200Returns the updated custom monitor, including its name, description, metadata, group assignment, status, and timestamps.
dataobjectoptional
successbooleanoptional
401Returned when the request is unauthenticated.
404Returned when the custom monitor is not found on the specified board.

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the board_id path parameter does not identify a board or the id path parameter does not identify a custom monitor on that board.