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

ListAlerts

List alert instances with pagination support

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • pageInteger

    1-based page number; 0 means no pagination 1-based page number; 0 means no pagination

    Example: 0

  • pageSizeInteger

    Results per page; default 20, max 200 Results per page; default 20, max 200

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of alert instances

    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

  • totalInteger

    Total number of matching alerts

    Example: 42

  • limitInteger

    Maximum items per page

    Example: 20

  • offsetInteger

    Offset from start of result set

    Example: 20

Endpoint

GET/api/v1/alerting/alerts

/api/v1/alerting/alerts

Operation ID

ListAlerts

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ],
  "total": 42,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history