Skip to main content
ZStack
Alerting & Response/Alert Events

ListAlerts

List alert instances with pagination support

GET/api/v1/alerting/alerts

Operation ID

ListAlerts

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • page
    Integer

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

    Example: 0

  • pageSize
    Integer

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

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of alert instances

    Example: (nested array)

    • uuid
      String

      Unique identifier of the alert instance

      Example: alert-789xyz

    • ruleUuid
      String

      UUID of the rule that generated this alert

      Example: rule-abc123-def456

    • ruleName
      String

      Name of the rule that generated this alert

      Example: High CPU Usage

    • resourceType
      String

      Type of monitored resource

      Example: vm

    • resourceUuid
      String

      UUID of the specific resource that triggered

      Example: res-abc123

    • metricName
      String

      Metric name that was evaluated

      Example: cpu_usage_percent

    • currentValue
      Long

      Current metric value at the time of alert

      Example: 95.3

    • threshold
      Long

      Threshold that was exceeded

      Example: 90

    • operator
      String

      Comparison operator used for evaluation

      Example: >

    • severity
      String

      Severity level of this alert

      Example: critical

    • state
      String

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

      Example: firing

    • message
      String

      Human-readable alert message

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

    • fingerprint
      String

      Unique fingerprint for alert deduplication

      Example: fp-abc123def456

    • source
      String

      Source system that generated the alert

      Example: prometheus

    • notifiedAt
      String

      Timestamp when the notification was sent

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

    • resolvedAt
      String

      Timestamp when the alert was resolved

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

    • acknowledgedBy
      String

      User who acknowledged this alert

      Example: admin

    • acknowledgedAt
      String

      Timestamp when the alert was acknowledged

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

    • createDate
      String

      Timestamp when the alert was created

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

  • total
    Integer

    Total number of matching alerts

    Example: 42

  • limit
    Integer

    Maximum items per page

    Example: 20

  • offset
    Integer

    Offset from start of result set

    Example: 20