Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Events
GETAlertingSince 1.0SynchronousAuth Required

GetAlertStormSummary

Retrieve summary details for a specific alert storm group

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • groupIdStringRequired

    Group identifier for the storm to retrieve

Responses

200 OK

On success, this API returns the following response structure.

  • groupIdString

    Unique group identifier for the storm

    Example: storm-group-001

  • groupKeyString

    Grouping key used to correlate alerts

    Example: host=db-01,severity=critical

  • firstSeenString

    Timestamp when the first alert in this storm occurred

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

  • lastSeenString

    Timestamp of the most recent alert in this storm

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

  • alertCountInteger

    Total number of alerts in this storm group

    Example: 47

  • sampleAlertsList

    Sample of representative alerts from this storm

    Example: (nested array)

    • uuidString

      Unique identifier of the alert instance

      Example: alert-789xyz

    • ruleUuidString

      UUID of the rule that generated this alert

      Example: rule-abc123-def456

    • ruleNameString

      Name of the rule that generated this alert

      Example: High CPU Usage

    • resourceTypeString

      Type of monitored resource

      Example: vm

    • resourceUuidString

      UUID of the specific resource that triggered

      Example: res-abc123

    • metricNameString

      Metric name that was evaluated

      Example: cpu_usage_percent

    • currentValueLong

      Current metric value at the time of alert

      Example: 95.3

    • thresholdLong

      Threshold that was exceeded

      Example: 90

    • operatorString

      Comparison operator used for evaluation

      Example: >

    • severityString

      Severity level of this alert

      Example: critical

    • stateString

      Current state of the alert (firing, resolved, acknowledged)

      Example: firing

    • messageString

      Human-readable alert message

      Example: CPU usage is 95.3%, exceeding threshold of 90%

    • fingerprintString

      Unique fingerprint for alert deduplication

      Example: fp-abc123def456

    • sourceString

      Source system that generated the alert

      Example: prometheus

    • notifiedAtString

      Timestamp when the notification was sent

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

    • resolvedAtString

      Timestamp when the alert was resolved

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

    • acknowledgedByString

      User who acknowledged this alert

      Example: admin

    • acknowledgedAtString

      Timestamp when the alert was acknowledged

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

    • createDateString

      Timestamp when the alert was created

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

  • affectedHostsList

    List of hosts affected by this storm

    Example: item1,item2

  • stateString

    Current state of the storm (active, resolved)

    Example: active

  • notifiedAtString

    Timestamp when the storm notification was sent

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

  • labelsLinkedHashMap

    Key-value labels attached to this resource

    Example: (nested object)

Endpoint

GET/api/v1/alerting/storms/{groupId}

/api/v1/alerting/storms/{groupId}

Operation ID

GetAlertStormSummary

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/storms/{groupId}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "groupId": "storm-group-001",
  "groupKey": "host=db-01,severity=critical",
  "firstSeen": "example",
  "lastSeen": "example",
  "alertCount": 47,
  "sampleAlerts": [
    {}
  ],
  "affectedHosts": [],
  "state": "active"
}

Change History

This API has no change history records yet.

View all change history