Skip to main content
ZStack
Alerting & Response/Alert Rules

CreateAlertSilenceRule

Create a silence rule to suppress alert notifications during a time window

POST/api/v1/alerting/silence-rules

Operation ID

CreateAlertSilenceRule

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

application/json

Body Fields

  • name
    StringRequired

    Human-readable name for the silence rule

    Example: Maintenance Window

  • description
    StringRequired

    Description of why alerts are being silenced

    Example: Suppress alerts during scheduled maintenance

  • matcherType
    StringRequired

    Type of label matcher (exact, regex, etc.)

    Example: value

  • matcherKey
    StringRequired

    Label key to match against

    Example: value

  • matcherValue
    StringRequired

    Label value pattern to match

    Example: value

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

  • matcherType
    String

    Type of label matcher (exact, regex, etc.)

    Example: value

  • matcherKey
    String

    Label key to match against

    Example: value

  • matcherValue
    String

    Label value pattern to match

    Example: value

  • 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

    Fixed R-R2-03: multiple label matchers (AND semantics). When non-empty, takes precedence over deprecated matcher_type/key/value fields.

    Example: (nested array)

    • type
      String

      Match type: exact or regex (Phase 2)

      Example: exact

    • key
      String

      Label key to match against

      Example: severity

    • value
      String

      Label value to match

      Example: critical