Add rule to ruleset
Adds a single rule to an existing ruleset. Use this endpoint to add a rule without having to include all the existing ruleset rules in the request.
Use one of the following API endpoints:
Operation | Method + Endpoint |
---|---|
Create an account ruleset rule | POST /accounts/{account_id}/rulesets/{ruleset_id}/rules |
Create a zone ruleset rule | POST /zones/{zone_id}/rulesets/{ruleset_id}/rules |
Include the rule definition in the request body.
By default, the rule will be added to the end of the existing list of rules in the ruleset. To define a specific position for the rule, include a position
object in the request body according to the guidelines in Change the order of a rule in a ruleset.
Invoking this method creates a new version of the ruleset.
Example
The following example adds a rule to ruleset {ruleset_id}
of zone {zone_id}
. The ruleset ID was previously obtained using the List zone rulesets operation, and corresponds to the entry point ruleset for the http_request_firewall_custom
phase.Request
The response includes the complete ruleset after adding the rule.Response
Define the rule position in the ruleset
To define the position of the new rule in the ruleset, include a position
object in the request, containing one of the following:
"before": "<RULE_ID>"
— Places the rule before rule<RULE_ID>
. Use this argument with an empty rule ID value (""
) to set the rule as the first rule in the ruleset."after": "<RULE_ID>"
— Places the rule after rule<RULE_ID>
. Use this argument with an empty rule ID value (""
) to set the rule as the last rule in the ruleset."index": <POSITION_NUMBER>
— Places the rule in the exact position specified by the integer number<POSITION_NUMBER>
. Position numbers start with1
. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten). For example, when you place a rule in position n usingindex
, existing rules with index n, n+1, n+2, and so on, are shifted one position — their new position will be n+1, n+2, n+3, and so forth. If the index is out of range, the method returns a400
HTTP status code.
For examples of using a position
object, refer to Update a rule in a ruleset.