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

CreateAlertSilenceTemplate

Create a reusable silence template for recurring maintenance windows

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • nameStringRequired

    Human-readable template name

    Example: Weekly Maintenance

  • descriptionStringRequired

    Description of the template purpose

    Example: Suppress non-critical alerts during weekly maintenance

  • matchersListRequired

    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

  • recurrenceObjectRequired

    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

  • createdByStringRequired

    User creating this template

    Example: admin

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

POST/api/v1/alerting/silence-templates

/api/v1/alerting/silence-templates

Operation ID

CreateAlertSilenceTemplate

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/silence-templates' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Weekly Maintenance","description":"Suppress non-critical alerts during weekly maintenance","matchers":"(nested array)","recurrence":{"cron":"0 2 * * 0","duration":120,"timezone":"Asia/Shanghai"},"createdBy":"admin"}'

Response Example

200
{
  "id": "tmpl-001",
  "name": "Weekly Maintenance",
  "description": "Suppress non-critical alerts during weekly maintenance",
  "matchers": [
    {}
  ],
  "recurrence": {},
  "protectP0": true,
  "createdBy": "admin",
  "createdAt": "example"
}

Change History

This API has no change history records yet.

View all change history