ORorq-ai
Alerts

Update an alert

Changed on

Updates alert metadata, query, condition, notifiers, or enabled state. Query and condition changes restart the evaluation schedule; disabling stops it. Alert scope, project_id, and telemetry source are immutable.

patch/v2/alerts/{alert_id}

Request

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

Path parameters

alert_idstring required

Alert 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.

signalstring

New UI signal preset. Omit to keep the current value.

notifier_idsstring[]

Replacement notifier set. Omit to keep the current notifiers.

enabledboolean

New enabled state. Omit to keep the current state.

Response

OK

Changes

  • 0b4e519a544fRevision changes
    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the non-success response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the required property ///// to the response with the status

  • 732aed62833aRevision changes
    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • info

      removed the non-success response with the status