Skip to main content
POST
Create silence rule

Restrictions

Usage

  • Set exactly one of time_filter (one-off window) or time_filters (recurring windows), and give filters at least one condition; otherwise InvalidParameter.
  • Each incoming event is checked against drop rules first, then silence rules, then inhibit rules. The first enabled silence rule whose window covers the current time and whose filters match is applied.
  • With from_incident_id, only one enabled silence rule may exist per incident; creating a second returns InvalidParameter.
  • An unknown channel_id returns InvalidParameter.
  • The caller must also be able to edit the channel: the account owner or an admin, the channel creator, or a member of its managing teams (of its owning team when managing_team_ids is empty). Otherwise the call returns AccessDenied.
  • Every call is recorded in the account audit log.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for creating a silence rule. Exactly one of time_filter or time_filters must be provided, and filters must be non-empty.

channel_id
integer<int64>
required

Owning channel ID; obtain it from POST /channel/list.

rule_name
string
required

Rule name, 1 to 39 characters.

Required string length: 1 - 39
description
string

Rule description, up to 500 characters.

Maximum string length: 500
from_incident_id
string

ID of the incident this rule is created from (24-character hex). The incident must exist, and only one enabled silence rule may exist per incident.

Pattern: ^[0-9a-fA-F]{24}$
time_filters
object[]

Recurring silence windows. Set exactly one of time_filters or time_filter.

time_filter
object

One-off silence window. Set exactly one of time_filter or time_filters.

filters
object[][]

Alert event conditions (OR of AND groups); matching events are silenced while the time window is active. Required, with at least one condition. Keys: title, description, severity (alias alert_severity, event_severity), status, alert_key, title_rule, integration_id (alias data_source_id), or any labels.<name>.

AND group — all conditions in this array must match.

is_directly_discard
boolean

When true, matching alert events are discarded entirely; when false, alerts are still recorded but marked as muted by this rule.

is_auto_delete
boolean

When true, a rule with a one-off time_filter is permanently removed about 24 hours after end_time (or after its last update, whichever is later). Rules created with from_incident_id are cleaned up the same way. Rules with recurring time_filters are never removed automatically. Defaults to false.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.