Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Rules
POSTAlertingSince 1.0SynchronousAuth Required

CreateAlertRule

Create a new alert rule with threshold and notification settings

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • nameStringRequired

    Human-readable name for the new alert rule

    Example: High CPU Usage

  • descriptionStringRequired

    Detailed description of the rule purpose

    Example: Alert when CPU exceeds 90%

  • resourceTypeStringRequired

    Resource type to monitor (e.g. vm, host)

    Example: vm

  • metricNameStringRequired

    Metric name to evaluate

    Example: cpu_usage_percent

  • operatorStringRequired

    Comparison operator for threshold check

    Example: >

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the alert rule

    Example: rule-abc123-def456

  • nameString

    Human-readable name of the alert rule

    Example: High CPU Usage

  • descriptionString

    Detailed description of what this rule monitors

    Example: Triggers when CPU usage exceeds 90% for 5 minutes

  • resourceTypeString

    Type of resource being monitored (e.g. vm, host, volume)

    Example: vm

  • metricNameString

    Name of the metric to evaluate

    Example: cpu_usage_percent

  • operatorString

    Comparison operator for threshold evaluation

    Example: >

  • thresholdLong

    Threshold value that triggers the alert

    Example: 90

  • durationInteger

    Duration in seconds the condition must hold before firing

    Example: 300

  • severityString

    Alert severity level (critical, warning, info)

    Example: critical

  • stateString

    Current state of the rule (enabled, disabled, firing)

    Example: enabled

  • notifyUrlString

    Webhook URL for delivery notifications

    Example: https://example.com/callback

  • platformUuidString

    UUID of the platform this rule belongs to

    Example: plat-001-abc

  • typeString

    Rule type: metric or log

    Example: metric

  • logQueryString

    Log query expression for log-based alert rules

    Example: level=error AND service=payment

  • logWindowInteger

    Time window in seconds for log query evaluation

    Example: 600

  • categoryString

    Category grouping for the rule (e.g. infrastructure, application)

    Example: infrastructure

  • labelSelectorsLinkedHashMap

    Fixed AU-ALERT-005: PRD §2.2 Key-Value label selectors (e.g. env="production"). Replaces previous string labels field with structured map for exact match support.

    Example: (nested object)

  • sourceString

    Source of the rule (builtin or custom)

    Example: builtin

  • impactScopeString

    Scope of impact when this alert fires

    Example: cluster

  • createDateString

    Timestamp when the rule was created

    Example: 2026-01-15T08:00:00Z

  • lastOpDateString

    Timestamp of the last modification to this rule

    Example: 2026-01-15T08:00:00Z

  • adapterTypeString

    Adapter type for the monitoring backend

    Example: prometheus

  • userModifiedBoolean

    Whether the user has manually modified this rule

    Example: false

  • deprecatedBoolean

    Whether this rule is deprecated and should not be used

    Example: false

  • createdByString

    Account ID of the user who created this rule

    Example: admin

  • lastModifiedByString

    Account ID of the user who last modified this rule

    Example: admin

  • actionsList

    Actions attached to this rule (FIX-02: RI-AA-V02)

    Example: (nested array)

    • uuidString

      Unique identifier of the action

      Example: action-001

    • ruleUuidString

      UUID of the parent alert rule

      Example: rule-abc123-def456

    • typeString

      Action type: command_snippet, link, or text_suggestion

      Example: command_snippet

    • labelString

      Display label for the action button

      Example: Restart Service

    • contentString

      Action content (command, URL, or suggestion text)

      Example: systemctl restart nginx

    • orderIndexInteger

      Display order index for multiple actions

      Example: 1

    • createDateString

      Timestamp when the action was created

      Example: 2026-01-15T08:00:00Z

Endpoint

POST/api/v1/alerting/rules

/api/v1/alerting/rules

Operation ID

CreateAlertRule

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/rules' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"High CPU Usage","description":"Alert when CPU exceeds 90%","resourceType":"vm","metricName":"cpu_usage_percent","operator":">","threshold":90.0,"duration":300,"severity":"critical","state":"enabled","notifyUrl":"https://example.com/callback","platformUuid":"plat-001-abc","type":"metric","logQuery":"level=error","logWindow":600,"actions":"(nested array)","labelSelectors":"(nested object)"}'

Response Example

200
{
  "uuid": "rule-abc123-def456",
  "name": "High CPU Usage",
  "description": "Triggers when CPU usage exceeds 90% for 5 minutes",
  "resourceType": "vm",
  "metricName": "cpu_usage_percent",
  "operator": ">",
  "threshold": 90.0,
  "duration": 300
}

Change History

This API has no change history records yet.

View all change history