Skip to main content
POST
Create inhibit rule

Restrictions

Usage

  • Requires the Standard license or higher; otherwise the call returns NoLicense.
  • An incoming event is inhibited when it matches target_filters and the same channel has an active (not recovered) alert with a different alert_key that matches source_filters, started within the 10 minutes before the event, and has the same value for every key in equals.
  • The rule never fires when equals or source_filters is empty, or when the incoming event has no value for a label listed in equals.
  • Inhibit rules are checked after drop and silence rules; the first matching inhibit rule is applied.
  • 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 an inhibit rule.

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
equals
string[]
required

Keys whose values must be equal on the source alert and the incoming event. Only title, severity and labels.<name> take effect; any other key (for example data_source_id) is accepted but makes the rule never fire. Must be present; an empty array also makes the rule inert.

description
string

Rule description, up to 500 characters.

Maximum string length: 500
source_filters
object[][]

Conditions the source (inhibiting) alert must match, evaluated against active alerts already stored in the channel. Keys: title, description, severity (alias incident_severity, alert_severity), status (alias incident_status, alert_status), or any labels.<name>. Empty makes the rule inert.

AND group — all conditions in this array must match.

target_filters
object[][]

Conditions the incoming target alert event must match to be inhibited; empty means every incoming event is a target. 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.

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.