View rulesets
You can list the available rulesets for a zone, account, or phase.
Example: View available rulesets at the zone level
The response to the GET request will include the following rulesets:
- Managed rulesets you can deploy, indicated by
"kind": "managed". - Zone-level phase entry points, if configured, indicated by
"kind": "zone". - Custom rulesets, if configured, indicated by
"kind": "custom".
curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets \--header "Authorization: Bearer <API_TOKEN>"{ "result": [ { "id": "<ZONE_PHASE_RULESET_ID>", "name": "Zone-level Ruleset 1", "description": "Ruleset for http_request_firewall_managed phase at the zone level", "kind": "zone", "version": "2", "last_updated": "2021-03-12T14:11:59.754817Z", "phase": "http_request_firewall_managed" }, { "id": "<CLOUDFLARE_MANAGED_RULESET_ID>", "name": "Cloudflare Managed Ruleset", "description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives", "kind": "managed", "version": "2", "last_updated": "2021-03-18T14:42:40.972022Z", "phase": "http_request_firewall_managed" }, { "id": "<CLOUDFLARE_OWASP_CORE_RULESET_ID>", "name": "Cloudflare OWASP Core Ruleset", "description": "Cloudflare's implementation of the Open Web Application Security Project (OWASP) ModSecurity Core Rule Set. We routinely monitor for updates from OWASP based on the latest version available from the official code repository", "kind": "managed", "version": "3", "last_updated": "2021-03-18T14:42:42.993211Z", "phase": "http_request_firewall_managed" } ], "success": true, "errors": [], "messages": []}Example: View available rulesets at the account level
The response will include the following rulesets:
- Managed rulesets you can deploy, indicated by
"kind": "managed". - Account-level phase entry points, if configured, indicated by
"kind": "root". - Custom rulesets, if configured, indicated by
"kind": "custom".
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets \--header "Authorization: Bearer <API_TOKEN>"{ "result": [ { "id": "<CUSTOM_RULESET_ID>", "name": "Custom Ruleset 1", "description": "My custom ruleset", "kind": "custom", "version": "10", "last_updated": "2020-11-23T11:36:24.192361Z", "phase": "http_request_firewall_custom" }, { "id": "<ACCOUNT_PHASE_RULESET_ID>", "name": "Account-level ruleset for http_request_firewall_managed phase", "description": "Account-level ruleset for executing one or more Managed Rulesets", "kind": "root", "version": "2", "last_updated": "2021-03-12T14:06:41.323932Z", "phase": "http_request_firewall_managed" }, { "id": "<CLOUDFLARE_MANAGED_RULESET_ID>", "name": "Cloudflare Managed Ruleset", "description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives", "kind": "managed", "version": "5", "last_updated": "2021-03-18T14:42:40.972022Z", "phase": "http_request_firewall_managed" }, { "id": "<CLOUDFLARE_OWASP_CORE_RULESET_ID>", "name": "Cloudflare OWASP Core Ruleset", "description": "Cloudflare's implementation of the Open Web Application Security Project (OWASP) ModSecurity Core Rule Set. We routinely monitor for updates from OWASP based on the latest version available from the official code repository", "kind": "managed", "version": "3", "last_updated": "2021-03-18T14:42:42.993211Z", "phase": "http_request_firewall_managed" } ], "success": true, "errors": [], "messages": []}You can view all versions of phase entry points (at the account and zone levels) and custom rulesets, but you can only view the most recent version of managed rulesets.
Example: View rules in a phase entry point ruleset at the zone level
The following example lists the rules in version 2 of the http_request_firewall_managed phase entry point ruleset at the zone level.
curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_request_firewall_managed/entrypoint/versions/2 \--header "Authorization: Bearer <API_TOKEN>"{ "result": { "id": "<RULESET_ID>", "name": "Zone-level phase entry point ruleset", "description": "This ruleset executes a managed ruleset.", "kind": "zone", "version": "2", "rules": [ { "id": "<RULE_ID>", "version": "1", "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: View rules in a managed ruleset
The following example lists the rules in version 2 of a managed ruleset (the most recent version of that ruleset).
Each rule in a managed ruleset can have associated tags or categories, listed in the categories field.
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets/{managed_ruleset_id}/versions/2 \--header "Authorization: Bearer <API_TOKEN>"{ "result": { "id": "<MANAGED_RULESET_ID>", "name": "Cloudflare Managed Ruleset", "description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives", "kind": "managed", "version": "2", "rules": [ { "id": "<RULE_1_ID>", "version": "1", "action": "log", "categories": [ "cve-2014-5265", "cve-2014-5266", "cve-2014-5267", "dos", "drupal", "wordpress" ], "description": "Drupal, Wordpress - DoS - XMLRPC - CVE:CVE-2014-5265, CVE:CVE-2014-5266, CVE:CVE-2014-5267", "last_updated": "2021-03-18T14:42:40.972022Z", "ref": "<RULE_1_REF>", "enabled": true }, { "id": "<RULE_2_ID>", "version": "1", "action": "block", "categories": ["broken-access-control", "cve-2018-12895", "wordpress"], "description": "Wordpress - Broken Access Control - CVE:CVE-2018-12895", "last_updated": "2021-03-18T14:42:40.972022Z", "ref": "<RULE_2_REF>", "enabled": true } // (...) ], "last_updated": "2021-03-18T14:42:40.972022Z", "phase": "http_request_firewall_managed" }, "success": true, "errors": [], "messages": []}For more information on the available API methods for viewing rulesets, refer to List and view rulesets.