Create via API
Use the Rulesets API to create a custom rule via API.
You must deploy custom rules to the http_request_firewall_custom
phase entry point ruleset.
To create a custom rule for a zone, add a rule to the http_request_firewall_custom
phase entry point ruleset.
-
Invoke the List zone rulesets method to obtain the list of rulesets in your zone. You will need the zone ID for this operation.
-
Search for an entry point ruleset for the
http_request_firewall_custom
phase in the response. Such a ruleset would have the following properties:"kind": "zone"
and“phase”: "http_request_firewall_custom"
. If you find the ruleset, take note of its ID for the next step. -
If the entry point ruleset already exists, invoke the Create a zone ruleset rule operation to add a custom rule to the existing ruleset. By default, the rule will be added at the end of the list of rules already in the ruleset. Refer to the examples below for details.
If the entry point ruleset does not exist, invoke the Create a zone ruleset operation to create the entry point ruleset with the new custom rule. Refer to Create ruleset for an example.
This example request, which covers step 3 in the rule creation procedure, adds a rule to the http_request_firewall_custom
phase entry point ruleset for the zone with ID {zone_id}
. The entry point ruleset already exists, with ID {ruleset_id}
.
The new rule, which will be the last rule in the ruleset, will challenge requests from the United Kingdom or France with a threat score greater than 10
:
To define a specific position for the new rule, include a position
object in the request body according to the guidelines in Change the order of a rule in a ruleset.
For instructions on creating an entry point ruleset and defining its rules using a single API call, refer to Add rules to phase entry point rulesets.
This example request, which covers step 3 in the rule creation procedure, adds a rule to the http_request_firewall_custom
phase entry point ruleset for the zone with ID {zone_id}
. The entry point ruleset already exists, with ID {ruleset_id}
.
The new rule, which will be the last rule in the ruleset, includes the definition of a custom response for blocked requests:
To define a specific position for the new rule, include a position
object in the request body according to the guidelines in Change the order of a rule in a ruleset.
For instructions on creating an entry point ruleset and defining its rules using a single API call, refer to Add rules to phase entry point rulesets.
Use the different operations in the Rulesets API to work with the rule you just created. The following table has a list of common tasks:
Task | Procedure |
---|---|
List all rules in ruleset | Use the Get a zone entry point ruleset operation with the For more information, refer to View a specific ruleset. |
Update a rule | Use the Update a zone ruleset rule operation. You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the Get a zone entry point ruleset operation with the For more information, refer to Update a rule in a ruleset. |
Delete a rule | Use the Delete a zone ruleset rule operation. You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the Get a zone entry point ruleset operation with the For more information, refer to Delete a rule in a ruleset. |
These operations are covered in the Ruleset Engine documentation. The Ruleset Engine powers different Cloudflare products, including custom rules.