ORorq-ai
Alerts

Create an alert

Changed on

Creates a project- or workspace-scoped threshold alert. The alert's query is validated against the selected telemetry source and the evaluation schedule starts immediately when enabled is true. Plan limits apply to the number of alerts and the minimum evaluation interval.

post/v2/alerts

Request

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

Request body

display_namestring required

Workspace-unique display name.

descriptionstring

Short human-readable summary of what the alert watches.

project_idstring

Project that owns a project alert. Empty for a workspace alert.

signalstring

UI signal preset the alert is created from. Defaults to custom.

notifier_idsstring[]

Notifiers that receive trigger-open and trigger-resolve notifications.

enabledboolean

Whether the alert starts evaluating immediately. Defaults to true.

scope'ALERT_SCOPE_PROJECT' | 'ALERT_SCOPE_WORKSPACE'

Example request

{
  "display_name": "High spend on production"
}

Response

OK

Changes

  • 0b4e519a544fRevision changes
    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • 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

      the request property became required

    • breaking

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

    • warning

      removed the request property /////

    • 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

    • info

      removed the non-success response with the status