Skip to main content
ZStack
Alerting & Response/Alert Rules

GetAlertSilenceRule

Retrieve a silence rule by identifier

GET/api/v1/alerting/silence-rules/{ruleUuid}

Operation ID

GetAlertSilenceRule

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

Path Parameters

  • ruleUuid
    StringRequired

    Unique UUID of the alert silence rule

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the silence rule

    Example: silence-001

  • name
    String

    Human-readable name of the silence rule

    Example: Maintenance Window Q1

  • description
    String

    Description of why this silence rule exists

    Example: Suppress alerts during scheduled maintenance

  • startsAt
    String

    Start time of the silence window

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

  • endsAt
    String

    End time of the silence window

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

  • createdBy
    String

    User who created this silence rule

    Example: admin

  • createDate
    String

    Timestamp when the silence rule was created

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

  • matchers
    List

    Matchers combined with AND semantics

    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

  • enabled
    Boolean

    Enabled for this resource

    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

  • lastOpDate
    String

    Last op date for this resource

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

  • version
    String

    Version for this resource

    Example: 10

  • currentHitCount
    String

    Distinct active alert owners currently matched by this silence rule

    Example: 3

  • matchersDisplay
    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