ORorq-ai
Monitors

Update a monitor

Changed on

Updates monitor metadata and widgets. With update_mask, listed paths are replaced and widgets may be explicitly cleared. Without update_mask, legacy behavior is preserved: a non-empty widgets array replaces the set and an empty or omitted array keeps it. project_id is immutable.

patch/v2/monitors/{monitor_id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/monitors/{monitor_id}
  • Auth
    HTTP bearer

Path parameters

monitor_idstring required

Monitor ID to update.

Request body

display_namestring

New workspace-unique display name. Omit to keep the current name.

descriptionstring

New description. Omit to keep the current description.

default_rangestring

New default relative time range. Omit to keep the current value unless update_mask contains default_range, which clears it.

update_maskstring field-mask

Optional explicit update presence. Listed paths are replaced; omitting the mask preserves the legacy partial-update behavior.

Response

OK

Changes