Skip to content
Firewall
Visit Firewall on GitHub
Set theme to dark (⇧+D)

Update and deploy rulesets

You can use the API to update basic properties of a ruleset (currently only the description) and the list of rules in the ruleset.

To configure a ruleset at the account or zone level, use one of the following API endpoints:

Account-level endpointPUT /accounts/{account-id}/rulesets/{root-ruleset-id}
Zone-level endpointPUT /zones/{zone-id}/rulesets/{root-ruleset-id}

Alternatively, you can use one of the following endpoints when updating the ruleset of a Phase:

Account-level Phase endpointPUT /accounts/{account-id}/rulesets/phases/{phase-name}/entrypoint
Zone-level Phase endpointPUT /zones/{zone-id}/rulesets/phases/{phase-name}/entrypoint

Example - Set the rules of a ruleset

Use this API method to set the rules of a ruleset. You must include all the rules you want to associate with the ruleset in every PUT request.

Requestcurl -X PUT \-H "X-Auth-Email: user@cloudflare.com" \-H "X-Auth-Key: REDACTED" \"https://api.cloudflare.com/client/v4/zones/{zone-id}/rulesets/{ruleset-id}" \-d '{  "rules": [    {      "action": "execute",      "action_parameters": {        "id": "{managed-ruleset-id}"      },      "expression": "true"    }  ]}'
Response{  "result": {    "id": "{ruleset-id}",    "name": "Zone-level Phase ruleset",    "description": "This ruleset deploys a Managed Ruleset.",    "kind": "zone",    "version": "4",    "rules": [      {        "id": "{rule-id}",        "version": "2",        "action": "execute",        "expression": "true",        "action_parameters": {          "id": "{managed-ruleset-id}"        },        "last_updated": "2021-03-17T15:42:37.917815Z"      }    ],    "last_updated": "2021-03-17T15:42:37.917815Z",    "phase": "http_request_firewall_managed"  },  "success": true,  "errors": [],  "messages": []}

Example - Deploy a ruleset

To deploy a ruleset, create a rule with the action field set to execute and add the ruleset ID to the action_parameters field in the id parameter. You deploy rulesets to a Phase.

This example deploys a Managed Ruleset to the zone-level http_request_firewall_managed Phase of a zone ({zone-id}).

Requestcurl -X PUT \-H "X-Auth-Email: user@cloudflare.com" \-H "X-Auth-Key: REDACTED" \"https://api.cloudflare.com/client/v4/zones/{zone-id}/rulesets/phases/http_request_firewall_managed/entrypoint" \-d '{  "rules": [    {      "action": "execute",      "action_parameters": {        "id": "{managed-ruleset-id}"      },      "expression": "true",      "description": "Execute Cloudflare Managed Ruleset on my Phase ruleset"    }  ]}'
Response{  "result": {    "id": "{phase-ruleset-id}",    "name": "Zone-level Phase ruleset",    "description": "",    "kind": "zone",    "version": "4",    "rules": [      {        "id": "{rule-id-1}",        "version": "1",        "action": "execute",        "action_parameters": {          "id": "{managed-ruleset-id}",          "version": "latest"        },        "expression": "true",        "description": "Execute Cloudflare Managed Ruleset on my Phase ruleset",        "last_updated": "2021-03-21T11:02:08.769537Z",        "ref": "{rule-ref-1}",        "enabled": true      }    ],    "last_updated": "2021-03-21T11:02:08.769537Z",    "phase": "http_request_firewall_managed"  },  "success": true,  "errors": [],  "messages": []}

For more information on deploying rulesets, check Deploy rulesets.

Example - Update ruleset description

You can use this API method to update the description of an existing ruleset.

Requestcurl -X PUT \-H "X-Auth-Email: user@cloudflare.com" \-H "X-Auth-Key: REDACTED" \"https://api.cloudflare.com/client/v4/zones/{zone-id}/rulesets/{ruleset-id}" \-d '{   "description": "My updated zone ruleset"}'
Response{  "result": {    "id": "{ruleset-id}",    "name": "Zone Ruleset",    "description": "My updated zone ruleset",    "kind": "zone",    "version": "4",    "rules": [      // (...)    ],    "last_updated": "2021-03-30T10:49:11.006109Z",    "phase": "http_request_firewall_managed"  },  "success": true,  "errors": [],  "messages": []}

The response includes the complete ruleset definition, including all the rules.