Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Templates
GETAlertingSince 1.0SynchronousAuth Required

ListAlertSilenceTemplates

List all available silence templates

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of silence templates

    Example: (nested array)

    • idString

      Unique identifier of the template

      Example: tmpl-001

    • nameString

      Human-readable template name

      Example: Weekly Maintenance

    • descriptionString

      Description of the template purpose

      Example: Suppress non-critical alerts during weekly maintenance

    • matchersList

      Label matchers for the silence scope

      Example: (nested array)

      • keyString

        Label key to match against

        Example: severity

      • valueString

        Label value to match

        Example: warning

      • matcherTypeString

        Match type: exact or regex

        Example: exact

    • recurrenceObject

      Optional recurrence configuration

      • cronString

        Cron expression for recurring silence windows

        Example: 0 2 * * 0

      • durationInteger

        Duration in minutes for each silence window

        Example: 120

      • timezoneString

        Timezone for cron evaluation

        Example: Asia/Shanghai

    • protectP0Boolean

      Whether to protect P0 (critical) alerts from being silenced

      Example: true

    • createdByString

      User who created this template

      Example: admin

    • createdAtString

      Timestamp when the template was created

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

  • totalInteger

    Total number of templates

    Example: 3

  • limitInteger

    Maximum items per page

    Example: 20

  • offsetInteger

    Offset from start of result set

    Example: 20

Endpoint

GET/api/v1/alerting/silence-templates

/api/v1/alerting/silence-templates

Operation ID

ListAlertSilenceTemplates

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/silence-templates' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 3,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history