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

CreateAlertSilenceRule

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

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 name for the silence rule

    Example: Maintenance Window

  • descriptionStringRequired

    Description of why alerts are being silenced

    Example: Suppress alerts during scheduled maintenance

  • matcherTypeStringRequired

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

    Example: value

  • matcherKeyStringRequired

    Label key to match against

    Example: value

  • matcherValueStringRequired

    Label value pattern to match

    Example: value

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the silence rule

    Example: silence-001

  • nameString

    Human-readable name of the silence rule

    Example: Maintenance Window Q1

  • descriptionString

    Description of why this silence rule exists

    Example: Suppress alerts during scheduled maintenance

  • matcherTypeString

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

    Example: value

  • matcherKeyString

    Label key to match against

    Example: value

  • matcherValueString

    Label value pattern to match

    Example: value

  • startsAtString

    Start time of the silence window

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

  • endsAtString

    End time of the silence window

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

  • createdByString

    User who created this silence rule

    Example: admin

  • createDateString

    Timestamp when the silence rule was created

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

  • matchersList

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

    Example: (nested array)

    • typeString

      Match type: exact or regex (Phase 2)

      Example: exact

    • keyString

      Label key to match against

      Example: severity

    • valueString

      Label value to match

      Example: critical

Endpoint

POST/api/v1/alerting/silence-rules

/api/v1/alerting/silence-rules

Operation ID

CreateAlertSilenceRule

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/silence-rules' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Maintenance Window","description":"Suppress alerts during scheduled maintenance","matcherType":"value","matcherKey":"value","matcherValue":"value","startsAt":"2026-01-15T08:00:00Z","endsAt":"2026-01-15T08:00:00Z","createdBy":"admin","matchers":"(nested array)"}'

Response Example

200
{
  "uuid": "silence-001",
  "name": "Maintenance Window Q1",
  "description": "Suppress alerts during scheduled maintenance",
  "matcherType": "example",
  "matcherKey": "example",
  "matcherValue": "example",
  "startsAt": "example",
  "endsAt": "example"
}

Change History

This API has no change history records yet.

View all change history