Skip to main content
ZStack
Alerting & Response/Alert Rules

ListAlertInhibitionRules

List all alert inhibition rules for suppressing correlated alerts

GET/api/v1/alerting/inhibition-rules

Operation ID

ListAlertInhibitionRules

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; 0 returns all matching rows, preserving existing behavior.

    Example: 0

  • pageSize
    Integer

    Results per page; default 20, maximum 200 when page is positive.

    Example: 0

  • search
    String

    Literal case-insensitive substring of stored policy name; empty matches all.

  • sortBy
    String

    name, createDate or lastOpDate. Empty preserves the existing default order, with UUID ascending as a tie breaker.

  • sortDirection
    String

    asc or desc for an explicit sortBy; defaults to asc.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of inhibition rules

    Example: (nested array)

    • uuid
      String

      Unique identifier of the inhibition rule

      Example: inhib-001

    • name
      String

      Human-readable rule name

      Example: Suppress disk alerts when host down

    • description
      String

      Rule description

      Example: Suppress disk alerts when host is unreachable

    • enabled
      Boolean

      Whether this inhibition rule is active

      Example: true

    • createDate
      String

      Timestamp when the rule was created

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

    • lastOpDate
      String

      Timestamp of the last modification

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

    • sourceMatchers
      List

      Source matchers for this resource

      Example: (nested array)

      • key
        String

        Whitelisted alert label key to match

        Example: severity

      • operator
        String

        Match operator: eq, neq, or regex

        Example: eq

      • value
        String

        Value used by the selected operator

        Example: critical

    • targetMatchers
      List

      Target matchers for this resource

      Example: (nested array)

      • key
        String

        Whitelisted alert label key to match

        Example: severity

      • operator
        String

        Match operator: eq, neq, or regex

        Example: eq

      • value
        String

        Value used by the selected operator

        Example: critical

    • equalLabelNames
      List

      Equal label names for this resource

      Example: item1,item2

    • reason
      String

      Reason for this resource

      Example: value

    • createdBy
      String

      Created by for this resource

      Example: value

    • lastModifiedBy
      String

      Last modified by for this resource

      Example: value

    • version
      String

      Version for this resource

      Example: 10

    • currentHitCount
      String

      Distinct active target alert owners currently matched by this inhibition rule

      Example: 3

    • sourceMatchersDisplay
      List

      Read-only matcher display in Content-Language; preserves original order and duplicate conditions

      Example: (nested array)

      • key
        String

        Original alert label key from the matcher, such as rule_uuid or resource_type, preserved unchanged alongside its localized display name.

        Example: value

      • operator
        String

        Operator for this resource

        Example: value

      • value
        String

        Value for this resource

        Example: value

      • displayName
        String

        Display name for this resource

        Example: value

      • valueDisplayName
        String

        Empty when unresolved or inaccessible; regex/nregex preserve the expression.

        Example: value

    • targetMatchersDisplay
      List

      Read-only matcher display in Content-Language; preserves original order and duplicate conditions

      Example: (nested array)

      • key
        String

        Original alert label key from the matcher, such as rule_uuid or resource_type, preserved unchanged alongside its localized display name.

        Example: value

      • operator
        String

        Operator for this resource

        Example: value

      • value
        String

        Value for this resource

        Example: value

      • displayName
        String

        Display name for this resource

        Example: value

      • valueDisplayName
        String

        Empty when unresolved or inaccessible; regex/nregex preserve the expression.

        Example: value

  • total
    Integer

    Total number of inhibition rules

    Example: 3

  • limit
    Integer

    Maximum items per page

    Example: 20

  • offset
    Integer

    Offset from start of result set

    Example: 20

  • actionabilityScope
    String

    Server-selected actionability scope used for current hit counts

    Example: platform_admin

  • asOf
    String

    RFC3339 timestamp identifying the suppression snapshot used for current hit counts

    Example: 2026-08-11T09:00:00Z

Change History

View all change history

  • Change Time

    AddedRequest parameters Accept-Language, page, pageSize...AddedResponse fields actionabilityScope, asOf, createdBy...DeletedResponse fields equalLabels, sourceMatch, targetMatch
    View API