Skip to main content
POST
Run Automation rule

Restrictions

Usage

  • Rate-limited to at most once per minute per rule; a second call within that window returns 429 with code: "RequestTooFrequently".
  • Only enabled rules can run manually; a disabled or misconfigured rule fails preflight with a 400 error before any run is created.
  • The call returns once the underlying agent session starts, not once the run finishes; the run continues asynchronously — use List Automation runs to check completion status.
  • trigger_kind is always manual for runs started this way, distinguishing them from schedule, http_post, and oncall_incident runs in run history.
  • 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
rule_id
string
required

Rule ID.

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.