Skip to main content
ZStack
Alerting & Response/Alert Rules

ListAlertMetrics

List available metrics that can be used in alert rules

GET/api/v1/alerting/rules/metrics

Operation ID

ListAlertMetrics

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

  • adapter
    String

    Filter by monitoring adapter type Filter by monitoring adapter type

  • object
    String

    Filter by object type Filter by object type

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of available metrics

    Example: (nested array)

    • abstractName
      String

      Abstract metric name for cross-adapter compatibility

      Example: cpu_usage

    • displayName
      String

      Human-readable display name

      Example: CPU Usage

    • objectType
      String

      Object type this metric applies to

      Example: vm

    • adapterType
      String

      Monitoring adapter type

      Example: prometheus

    • promqlMetric
      String

      Actual PromQL metric name

      Example: node_cpu_seconds_total

    • unit
      String

      Unit of measurement for the metric

      Example: percent

  • total
    Integer

    Total number of matching metrics

    Example: 24

  • limit
    Integer

    Maximum items per page

    Example: 20

  • offset
    Integer

    Offset from start of result set

    Example: 20