Skip to main content
POST
Update silence rule

Restrictions

Usage

  • The same time window and filters requirements as create apply. Switching between time_filter and time_filters clears the other one.
  • description, is_directly_discard and is_auto_delete are always overwritten, so omitting them resets them to empty or false. from_incident_id cannot be changed.
  • An unknown channel_id or rule_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 updating 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_id
string
required

Silence rule ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
rule_name
string
required

Rule name, 1 to 39 characters.

Required string length: 1 - 39
description
string

Rule description, up to 500 characters. Omitting it clears the stored description.

Maximum string length: 500
time_filters
object[]

Recurring time windows. Mutually exclusive with time_filter.

time_filter
object

One-off silence window. Mutually exclusive with time_filters; exactly one of the two must be set.

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 silenced by this rule. Omitting it sets it to false.

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. Omitting it sets it 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

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.