Skip to main content
ZStack
Alerting & Response/Alert Rules

PreviewAlertSilenceRuleChange

Preview how updating, disabling, or deleting a silence rule changes current suppression without mutating state

POST/api/v1/alerting/silence-rules/{ruleUuid}/preview-change

Operation ID

PreviewAlertSilenceRuleChange

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

  • ruleUuid
    StringRequired

    UUID of the silence rule to preview

Body Fields

  • operation
    String

    Preview operation: update, disable, or delete

    Example: update

  • candidate
    Object

    Candidate update, required when operation is update

    • ruleUuid
      String

      Rule uuid for this resource

      Example: value

    • name
      String

      Updated silence rule name

      Example: Maintenance Window Q1

    • description
      String

      Description for this resource

      Example: A brief description

    • matchers
      List

      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

    • startsAt
      String

      Starts at for this resource

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

    • endsAt
      String

      Ends at for this resource

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

    • enabled
      Boolean

      Whether the silence rule is enabled

      Example: true

    • timezone
      String

      Timezone for this resource

      Example: value

    • reason
      String

      Reason for this resource

      Example: value

    • lastModifiedBy
      String

      Last modified by 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