Skip to main content
POST
Run Automation rule now

Restrictions

Usage

  • This endpoint does not create a new trigger configuration. It starts one real run immediately from the rule’s current configuration.
  • The service performs preflight checks first. If they pass, it creates a manual run and executes the hidden session asynchronously.
  • A successful response returns run_id and, after the session is created, session_id, which you can use to open the corresponding session and inspect messages, tool calls, and artifacts.
  • Manual runs are limited to one per rule per minute; excessive calls return 429.

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

Endpoint-specific payload. See each operation's 200 response schema.