Skip to main content
POST
Create inhibit rule

Restrictions

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

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

Field keys whose values must be equal between the source (inhibiting) alert and the target (suppressed) alert, e.g. data_source_id or labels.cluster.

description
string

Rule description, up to 500 characters.

Maximum string length: 500
source_filters
object[][]

Conditions the source alert must match, evaluated against stored active alerts. Supported keys: status, incident_status, alert_status, severity, incident_severity, alert_severity, title, description, or any labels.<name>. Empty makes the rule inert.

target_filters
object[][]

Conditions the incoming target alert event must match to be suppressed; empty means every event is a target.

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
required

Endpoint-specific payload. See each operation's 200 response schema.