Skip to main content
POST
Update drop rule

Restrictions

Usage

  • Full replacement: an omitted description becomes empty, and an omitted filters clears all conditions so the rule matches nothing.
  • 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 channel drop rule.

channel_id
integer<int64>
required

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

rule_id
string
required

Drop 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
filters
object[][]

Alert event conditions (OR of AND groups); matching events are discarded entirely. Keys: title, description, severity (alias alert_severity, event_severity), status, alert_key, title_rule, integration_id (alias data_source_id), or any labels.<name>. The stored conditions are replaced; omitting this field clears them and the rule then matches nothing.

AND group — all conditions in this array must match.

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.