Actions
Endpoints for managing the actions FlowGuard applies when rules match.
List actions
List the authenticated team's reusable rule actions, newest first. Results can be searched by name and include the number of rules using each action.
query Parameters
querySearch results by name.
per_pageNumber of results per page.
pagePage number to return.
List actions › Responses
Array of Action
Create an action
Create a reusable action for the authenticated team. The selected result determines which configuration fields are applicable; consult the rule capabilities endpoint for supported results and defaults.
Create an action › Request Body
nameHuman-readable action name.
resultResult applied when a rule using this action matches.
status_codeHTTP status returned by results that produce a response.
messageResponse message returned by results that produce a response.
window_secondsRate-limit window in seconds. Required when result is rate_limit.
requests_per_windowRequests allowed during the rate-limit window. Required when result is rate_limit.
Create an action › Responses
The action was created.
Show an action
Show one reusable action belonging to the authenticated team, including its result configuration and the number of rules using it.
path Parameters
actionShow an action › Responses
Action
Update an action
Update an action belonging to the authenticated team. Omitted fields retain their current values. Changing the result replaces result-specific configuration with the supplied values and defaults for the new result.
path Parameters
actionUpdate an action › Request Body
nameHuman-readable action name.
resultResult applied when a rule using this action matches.
status_codeHTTP status returned by results that produce a response.
messageResponse message returned by results that produce a response.
window_secondsRate-limit window in seconds. Required when result is rate_limit.
requests_per_windowRequests allowed during the rate-limit window. Required when result is rate_limit.
Update an action › Responses
Action