Skip to main content
ZStack
Alerting & Response/Alert Rules

PreviewAlertInhibitionRuleChange

Preview how updating, disabling, or deleting an inhibition rule changes current suppression without mutating state

POST/api/v1/alerting/inhibition-rules/{ruleId}/preview-change

Operation ID

PreviewAlertInhibitionRuleChange

Since

1.2.8

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

application/json

Path Parameters

  • ruleId
    StringRequired

    UUID of the inhibition rule to preview

Body Fields

  • operation
    String

    Preview operation: update, disable, or delete

    Example: update

  • candidate
    Object

    Candidate update, required when operation is update

    • ruleId
      String

      Inhibition rule identifier to update

      Example: inhib-001

    • name
      String

      New rule name

      Example: Updated inhibition rule

    • description
      String

      New rule description

      Example: Updated description

    • enabled
      Boolean

      New enabled state

      Example: true

    • sourceMatchers
      List

      Source matchers for this resource

      Example: (nested array)

    • targetMatchers
      List

      Target matchers for this resource

      Example: (nested array)

    • equalLabelNames
      List

      Equal label names for this resource

      Example: item1,item2

    • reason
      String

      Reason for this resource

      Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • willReleaseCount
    String

    Owners that would become actionable

    Example: 2

  • willRemainSuppressedCount
    String

    Owners that would remain covered by this or another suppression rule

    Example: 1

  • unknownCount
    String

    Owners whose post-change suppression state cannot be determined reliably

    Example: 1

  • asOf
    String

    RFC3339 timestamp identifying the immutable suppression snapshot used by the preview

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