Skip to main content
POST
Run Automation rule

Restrictions

Usage

  • A manual run does not require the rule to be enabled. It fails with 400 before any run is created if the rule’s configuration is invalid (for example a BYOC runner the rule’s scope may not use), or if the only enabled trigger is the war room trigger (such a rule has no web console run).
  • A personal rule whose owner has left the account is disabled automatically and the call returns 400.
  • At most one manual run per rule per minute; a second call within that window returns 429 with code: "RequestTooFrequently".
  • Manage rights: a personal rule (team_id=0) can be managed only by its owner; a team rule only by members of that team. Account owners and admins get no exemption and must join the team.
  • While another update, delete, or manual run of the same rule is in progress, the call fails with HTTP 423 and code: "RequestLocked"; retry later.
  • The call returns once the agent session has started, not when the run finishes. Track completion with List Automation runs (trigger_kind=manual).
  • run.session_id is omitted for rules that execute in an IM chat (execution_place=im).
  • 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
rule_id
string
required

Rule ID, from the list returned by POST /safari/automation/rule/list.

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

Result of manually running an Automation rule outside its schedule.