Deploy managed rulesets and a custom ruleset
Use a single API request to add rules to your root ruleset and deploy managed and custom rulesets.
In the example below, the root ruleset configuration contains a rule to deploy a ruleset. To keep the rule in the new version of your root ruleset, you must include the rule in the request along with the rulesets you want to deploy.
- View the usable rulesets and managed rulesets. Use the
jqJSON processor to filter thenameandidparameters of the rulesets.
The response lists the$ curl -s -X GET "https://api.cloudflare.com/client/v4/accounts/{account-id}/rulesets" | jq .result[] | jq '.name, .id'nameandidparameters for the rulesets that you can use:"Cloudflare OWASP Core Ruleset""{Cloudflare-owasp-ruleset-id}""Cloudflare Managed Ruleset""{Cloudflare-managed-ruleset-id}""Custom Ruleset 2""{custom-ruleset-2-id}""Custom Ruleset 1""{custom-ruleset-1-id}""Root ruleset for my account""{root-ruleset-id}" - Fetch your root ruleset to view the
idof the existing rules to keep in the new version.
The reponse indicates that the only ruleset deployed is the Cloudflare OWASP managed ruleset.curl -s -X GET "https://api.cloudflare.com/client/v4/accounts/{account-id}/rulesets/{root-ruleset-id}/versions/{version-number}"{"result": { "id": "{root-ruleset-id}", "name": "Root ruleset for my account", "kind": "root", "version": "49", "rules": [ { "id": "{rule-deploying-owasp-id}", "version": "1", "action": "execute", "action_parameters": { "id": "{Cloudflare-owasp-ruleset-id}", "version": "latest" }, "expression": "cf.zone.name eq \"example.com\"", "last_updated": "2020-11-20T15:50:29.861157Z", "ref": "{rule-deploying-owasp-id}", "enabled": true }]}}
Use the Modify ruleset endpoint to preserve the rule that deploys the OWASP managed ruleset. Deploy the Cloudflare Managed Ruleset with an override and and deploy a custom ruleset.
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/{account-id}/rulesets/{root-ruleset-id}" -d'{ "rules": [ { "id": "{Cloudflare-owasp-ruleset-id}" }, { "action": "execute", "expression": "cf.zone.name eq \"example.com\"","action_parameters": { "id": "{custom-ruleset-1-id}" } }, { "action": "execute", "expression": "cf.zone.name eq \"example.com\"", "action_parameters": { "id": "{Cloudflare-managed-ruleset-id}", "overrides": { "categories": [ { "category": "joomla", "action": "block" }] } } }]}'The response displays the new version of your root ruleset. The rules[] array in the ruleset contains three rules.
{rule-deploying-owasp-id}: The rule that deploys the OWASP ruleset.{rule-deploying-custom-ruleset-1-id}: The rule that deploys the custom ruleset.{rule-deploying-Cloudflare-managed-ruleset-id}: The rule that deploys the Cloudflare Managed ruleset. This rule contains overrides.
"result": { "id": "{root-ruleset-id}", "name": "Root ruleset for my account", "kind": "root", "version": "56", "rules": [ { "id": "{rule-deploying-owasp-id}", "version": "1", "action": "execute", "action_parameters": { "id": "{Cloudflare-owasp-ruleset-id}", "version": "latest" }, "expression": "cf.zone.name eq \"example.com\"", "last_updated": "2020-11-23T11:58:47.421464Z", "ref": "{rule-deploying-owasp-id}", "enabled": true }, { "id": "{rule-deploying-custom-ruleset-1-id}", "version": "1", "action": "execute", "action_parameters": { "id": "{custom-ruleset-1-id}", "version": "latest" }, "expression": "cf.zone.name eq \"example.com\"", "last_updated": "2020-11-23T13:28:09.793359Z", "ref": "{rule-deploying-custom-ruleset-1-id}", "enabled": true }, { "id": "{rule-deploying-Cloudflare-managed-ruleset-id}", "version": "1", "action": "execute", "action_parameters": { "id": "{Cloudflare-managed-ruleset-id}", "version": "latest", "overrides": { "categories": [ { "category": "joomla", "action": "block" } ] } }, "expression": "cf.zone.name eq \"example.com\"", "last_updated": "2020-11-23T13:28:09.793359Z", "ref": "{rule-deploying-Cloudflare-managed-ruleset-id}", "enabled": true } ] }}