Skip to content

Deploy rulesets

Last updated View as MarkdownAgent setup

Use the Rulesets API to deploy a ruleset. To deploy a ruleset, add a rule with "action": "execute" to a phase entry point ruleset, specifying the ruleset ID to execute as an action parameter. Use a separate rule for each ruleset you want to deploy.

A rule that executes a ruleset consists of:

  • The ID of the ruleset you want to execute, included in action_parameters.id.
  • An expression.
  • The execute action.

The rules in the ruleset execute when a request satisfies the expression.

Example

The following example deploys the Cloudflare Managed Ruleset (with ID ) to the http_request_firewall_managed phase of a given zone ($ZONE_ID) by adding a rule that executes the managed ruleset.

Required API token permissions

At least one of the following token permissions is required:
  • Response Compression Write
  • Config Settings Write
  • Dynamic URL Redirects Write
  • Cache Settings Write
  • Custom Errors Write
  • Origin Write
  • Managed headers Write
  • Zone Transform Rules Write
  • Mass URL Redirects Write
  • Magic Firewall Write
  • L4 DDoS Managed Ruleset Write
  • HTTP DDoS Managed Ruleset Write
  • Sanitize Write
  • Transform Rules Write
  • Select Configuration Write
  • Bot Management Write
  • Zone WAF Write
  • Account WAF Write
  • Account Rulesets Write
  • Logs Write
  • Logs Write
Update a zone entry point rulesetbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"action": "execute",
						"action_parameters": {
								"id": "efb7b8c949ac4650a09736fc376e9aee"
						},
						"expression": "true",
						"description": "Execute Cloudflare Managed Ruleset on my zone ruleset"
				}
		]
	}'
{
	"result": {
		"id": "<ZONE_PHASE_RULESET_ID>",
		"name": "Zone-level Ruleset 1",
		"description": "",
		"kind": "zone",
		"version": "latest",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "execute",
				"action_parameters": {
					"id": "efb7b8c949ac4650a09736fc376e9aee",
					"version": "3"
				},
				"expression": "true",
				"description": "Execute Cloudflare Managed Ruleset on my zone ruleset",
				"last_updated": "2021-03-18T18:08:14.003361Z",
				"ref": "<RULE_REF>",
				"enabled": true
			}
		],
		"last_updated": "2021-03-18T18:08:14.003361Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

For more examples of deploying rulesets, refer to the following pages:

Refer to Work with managed rulesets and Work with custom rulesets for more information.