Skip to main content
POST
Update Automation rule

Restrictions

Usage

  • Omitted or null fields are left unchanged; team_id cannot be changed from its current value.
  • cron_expr and timezone can be updated independently — sending only one keeps the other at its current stored value.
  • rotate_http_post_trigger_token=true issues a fresh webhook token, returned only in this response.
  • To trigger from On-call incidents, send oncall_incident_trigger_enabled, oncall_incident_channel_ids, and oncall_incident_severities; matching events run with trigger_kind=oncall_incident.
  • Every call is recorded in the account audit log.

Authorizations

app_key
string
query
required

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

Body

application/json

Update an Automation rule. Omit or send null on a field to leave it unchanged.

rule_id
string
required

Target rule ID.

name
string | null

New rule name.

Maximum string length: 255
team_id
integer<int64> | null

Only the current value is accepted; personal/team scope is immutable after creation.

Required range: x >= 0
enabled
boolean | null

Whether the rule is enabled.

cron_expr
string | null

Run cadence. Supports 4 fields (hour day month weekday, minute defaults to 0) and 5 fields (minute hour day month weekday). The minute must be one fixed integer; 6-field seconds are not supported.

Example:

"15 9 * * *"

timezone
string | null

New IANA timezone for evaluating cron_expr. Omit or send null to leave the current timezone unchanged.

schedule_trigger_enabled
boolean | null

Whether the schedule trigger is enabled.

prompt
string | null

New task prompt.

environment_kind
enum<string> | null

Runtime environment kind. Omit or send an empty value for automatic selection.

Available options:
,
cloud,
byoc
environment_id
string | null

BYOC Runner ID.

http_post_trigger_enabled
boolean | null

Whether the HTTP POST trigger is enabled. Sending true creates one when missing.

oncall_incident_trigger_enabled
boolean | null

Whether the On-call incident trigger is enabled.

oncall_incident_channel_ids
integer<int64>[]

On-call integration IDs to watch. Creating or enabling this trigger requires at least one valid ID.

Required range: x >= 1
oncall_incident_severities
enum<string>[]

Incident severities to watch. Supported values are Critical, Warning, and Info; creating or enabling this trigger requires at least one value.

Available options:
Critical,
Warning,
Info
rotate_http_post_trigger_token
boolean

Whether to rotate the HTTP POST trigger token. The new token is returned only in this response.

Response

Success

Standard response envelope used by every Flashduty public API. On success data contains the endpoint-specific payload and error is absent. On failure error is present and data is absent. request_id is always present and is also mirrored in the Flashcat-Request-Id response header.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

Error payload inside the response envelope. Present only on non-2xx responses.

data
object

Automation rule.