Skip to main content
POST
Update escalation rule

Restrictions

Usage

  • Full replacement: omitted description, aggr_window, time_filters and filters are reset to empty or 0. Only priority keeps its current value when omitted.
  • Validation is the same as for create. The rule’s status is not changed; use the enable and disable endpoints.
  • 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 an escalation rule.

channel_id
integer<int64>
required

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

rule_id
string
required

Escalation rule ID (MongoDB ObjectID).

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

Notification template ID (24-character hex); obtain it from POST /template/list. Must exist.

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

Rule name, 1 to 39 characters.

Required string length: 1 - 39
layers
object[]
required

Escalation levels in order. At least one level is required.

Minimum array length: 1
priority
integer | null

Evaluation order; lower values are evaluated first. Omit or pass null to keep the current value.

aggr_window
integer

Delay in seconds before the first notification for a newly assigned incident; 0 notifies immediately. Omitting it resets the value to 0.

description
string

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

Maximum string length: 500
time_filters
object[]

Recurring time windows during which the rule can match. Replaces the stored windows; omit or leave empty to match at any time.

filters
object[][]

Incident conditions (OR of AND groups), matched against the incident the alert was grouped into, not against the alert. Keys: title, description, severity (alias incident_severity, alert_severity), status (alias incident_status, alert_status), dedup_key, integration_id (alias data_source_id), or any labels.<name>. Replaces the stored conditions; omit or leave empty to match every incident in the channel.

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.