Rules
Endpoints for discovering and managing FlowGuard request-matching rules.
Show rule capabilities
Return the condition operators, match types, action results, server scope modes, and nesting limit supported by the current FlowGuard API. Use these capabilities to construct valid rule payloads.
Show rule capabilities › Responses
The rule language and action capabilities supported by the current API.
List rules
List the authenticated team's rules in evaluation order. A lower position is evaluated first. Results can be searched by name and are paginated.
query Parameters
querySearch results by name.
per_pageNumber of results per page.
pagePage number to return.
List rules › Responses
Array of Rule
Create a rule
Create a rule for the authenticated team. The optional action must belong to the same team. A supplied zero-based position inserts the rule at that point and shifts later rules down; when omitted, the rule is appended.
Create a rule › Request Body
nameHuman-readable rule name.
Recursive condition group. Each group contains an AND or OR operator, a list of matches, and nested groups. Consult the rule capabilities endpoint for supported match types and operators.
Server scope controlling which proxies evaluate the rule.
action_idFormatted ID of an action owned by the authenticated team. Send null for a match-only rule.
positionZero-based evaluation position. Omit when creating to append the rule; omit when updating to retain its current position.
Create a rule › Responses
The rule was created.
Show a rule
Show one rule belonging to the authenticated team, including its conditions, action, server scope, and evaluation position.
path Parameters
ruleShow a rule › Responses
Rule
Update a rule
Update a rule belonging to the authenticated team. Omitted top-level fields retain their current values. Set action_id to null to detach the action; changing position reorders the team's rules.
path Parameters
ruleUpdate a rule › Request Body
nameHuman-readable rule name.
Recursive condition group. Each group contains an AND or OR operator, a list of matches, and nested groups. Consult the rule capabilities endpoint for supported match types and operators.
Server scope controlling which proxies evaluate the rule.
action_idFormatted ID of an action owned by the authenticated team. Send null for a match-only rule.
positionZero-based evaluation position. Omit when creating to append the rule; omit when updating to retain its current position.
Update a rule › Responses
Rule
Disable a rule
Remove the action assigned to a rule belonging to the authenticated team. The rule and its conditions remain available for later use.
path Parameters
ruleDisable a rule › Responses
Rule