Skip to main content
ZStack
Alerting & Response/Alert Templates

ListAlertSilenceTemplates

List all available silence templates

GET/api/v1/alerting/silence-templates

Operation ID

ListAlertSilenceTemplates

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of silence templates

    Example: (nested array)

    • id
      String

      Unique identifier of the template

      Example: tmpl-001

    • name
      String

      Human-readable template name

      Example: Weekly Maintenance

    • description
      String

      Description of the template purpose

      Example: Suppress non-critical alerts during weekly maintenance

    • matchers
      List

      Label matchers for the silence scope

      Example: (nested array)

      • key
        String

        Label key to match against

        Example: severity

      • value
        String

        Label value to match

        Example: warning

      • matcherType
        String

        Match type: exact or regex

        Example: exact

    • recurrence
      Object

      Optional recurrence configuration

      • cron
        String

        Cron expression for recurring silence windows

        Example: 0 2 * * 0

      • duration
        Integer

        Duration in minutes for each silence window

        Example: 120

      • timezone
        String

        Timezone for cron evaluation

        Example: Asia/Shanghai

    • protectP0
      Boolean

      Whether to protect P0 (critical) alerts from being silenced

      Example: true

    • createdBy
      String

      User who created this template

      Example: admin

    • createdAt
      String

      Timestamp when the template was created

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

  • total
    Integer

    Total number of templates

    Example: 3

  • limit
    Integer

    Maximum items per page

    Example: 20

  • offset
    Integer

    Offset from start of result set

    Example: 20