导航|地址|刷新
View rulesets

Skip to contentDocumentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/ruleset-engine/llms.txt
Use this file to discover all available pages before exploring further.



DocsDirectoryAPISDKsChangelog

Search

Log in






Ruleset Engine

/




Overview


About


Overview

Phases

Rulesets

Rules






Basic API operations


View rulesets

Add rules to phase entry point rulesets

Deploy rulesets






Work with managed rulesets


Overview

Deploy a managed ruleset

Override a managed ruleset


Override examples


Overview

Set WordPress rules to Block

Enable only Joomla rules

Enable only selected rules

Deploy a managed ruleset with ruleset, tag, and rule overrides

Adjust the sensitivity of an HTTP DDoS rule to Low

Adjust an L3/4 DDoS rule ↗





Create an exception






Work with custom rulesets


Overview

Create a custom ruleset

Add rules to a custom ruleset

Deploy a custom ruleset






Rules language


Overview


Expressions


Overview

Edit in the dashboard





Operators and grouping symbols

Values

Actions


Fields


Overview

Fields reference





Functions






Rulesets API


Overview

JSON objects

Endpoints

List and view rulesets

Create a ruleset

Update or deploy a ruleset

Add a rule to a ruleset

Update a rule in a ruleset

Delete a rule in a ruleset

Delete a ruleset






Reference


Phases list






Agent resources


Agent setup ↗

Cloudflare Skills ↗

Code Mode MCP Server ↗

Domain-specific MCP Servers ↗MCP

Ruleset Engine llms.txt ↗

Ruleset Engine llms-full.txt ↗

Cloudflare Docs llms.txt ↗

Cloudflare Docs llms-full.txt ↗













Home

/Ruleset Engine

/Basic API operations

/View rulesets



View rulesets


Last updated Apr 16, 2026|Copy as Markdown|View as Markdown|Agent setup

OverviewView available rulesets Example: View available rulesets at the zone level Example: View available rulesets at the account levelGet an entry point ruleset Example: Get an entry point ruleset at the zone level Example: Get an entry point ruleset at the account levelView the rules included in a ruleset Example: View rules in a phase entry point ruleset at the zone level Example: View rules in a managed rulesetRelated resources




This page includes examples of the following API operations:

View available rulesets

Get an entry point ruleset

View the rules included in a ruleset


View available rulesets


You can list the available rulesets for a zone or account.

For a list of API endpoints refer to List and view rulesets.


Example: View available rulesets at the zone level


The response to the GET request obtaining the list of rulesets at the zone level will include the following rulesets:

Managed rulesets you can deploy, indicated by "kind": "managed".

Zone-level phase entry point rulesets, if configured, indicated by "kind": "zone".

Custom rulesets, if configured, indicated by "kind": "custom".

Required API token permissions
At least one of the following token permissions is required:
Response Compression Write

Response Compression Read

Config Settings Write

Config Settings Read

Dynamic URL Redirects Write

Dynamic URL Redirects Read

Cache Settings Write

Cache Settings Read

Custom Errors Write

Custom Errors Read

Origin Write

Origin Read

Managed headers Write

Managed headers Read

Zone Transform Rules Write

Zone Transform Rules Read

Mass URL Redirects Write

Mass URL Redirects Read

Magic Firewall Write

Magic Firewall Read

L4 DDoS Managed Ruleset Write

L4 DDoS Managed Ruleset Read

HTTP DDoS Managed Ruleset Write

HTTP DDoS Managed Ruleset Read

Sanitize Write

Sanitize Read

Transform Rules Write

Transform Rules Read

Select Configuration Write

Select Configuration Read

Bot Management Write

Bot Management Read

Zone WAF Write

Zone WAF Read

Account WAF Write

Account WAF Read

Account Rulesets Read

Account Rulesets Write

Logs Write

Logs Read

Logs Write

Logs Read
List zone rulesetsbashcurl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets" \ --request GET \ --header "Authorization: Bearer $CLOUDFLARE_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 to the GET request obtaining the list of rulesets at the account level will include the following rulesets:

Managed rulesets you can deploy, indicated by "kind": "managed".

Account-level phase entry point rulesets, if configured, indicated by "kind": "root".

Custom rulesets, if configured, indicated by "kind": "custom".

Required API token permissions
At least one of the following token permissions is required:
Mass URL Redirects Write

Mass URL Redirects Read

Magic Firewall Write

Magic Firewall Read

L4 DDoS Managed Ruleset Write

L4 DDoS Managed Ruleset Read

Transform Rules Write

Transform Rules Read

Select Configuration Write

Select Configuration Read

Account WAF Write

Account WAF Read

Account Rulesets Read

Account Rulesets Write

Logs Write

Logs Read
List account rulesetsbashcurl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets" \ --request GET \ --header "Authorization: Bearer $CLOUDFLARE_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": []}

Get an entry point ruleset


You can get the definition of the entry point ruleset of a given phase at the zone or account level.

If the entry point ruleset exists, the API will return a 200 OK HTTP status code, along with the ruleset definition.

If the entry point ruleset does not exist, the API will return a 404 Not Found HTTP status code.


Example: Get an entry point ruleset at the zone level


The following GET request obtains the definition of the entry point ruleset for the http_request_firewall_managed phase at the zone level. In this case, the entry point ruleset exists and contains one rule.

Required API token permissions
At least one of the following token permissions is required:
Response Compression Write

Response Compression Read

Config Settings Write

Config Settings Read

Dynamic URL Redirects Write

Dynamic URL Redirects Read

Cache Settings Write

Cache Settings Read

Custom Errors Write

Custom Errors Read

Origin Write

Origin Read

Managed headers Write

Managed headers Read

Zone Transform Rules Write

Zone Transform Rules Read

Mass URL Redirects Write

Mass URL Redirects Read

Magic Firewall Write

Magic Firewall Read

L4 DDoS Managed Ruleset Write

L4 DDoS Managed Ruleset Read

HTTP DDoS Managed Ruleset Write

HTTP DDoS Managed Ruleset Read

Sanitize Write

Sanitize Read

Transform Rules Write

Transform Rules Read

Select Configuration Write

Select Configuration Read

Bot Management Write

Bot Management Read

Zone WAF Write

Zone WAF Read

Account WAF Write

Account WAF Read

Account Rulesets Read

Account Rulesets Write

Logs Write

Logs Read

Logs Write

Logs Read
Get a zone entry point rulesetbashcurl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \ --request GET \ --header "Authorization: Bearer $CLOUDFLARE_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: Get an entry point ruleset at the account level


The following GET request obtains the definition of the entry point ruleset for the http_request_firewall_managed phase at the account level.

Required API token permissions
At least one of the following token permissions is required:
Mass URL Redirects Write

Mass URL Redirects Read

Magic Firewall Write

Magic Firewall Read

L4 DDoS Managed Ruleset Write

L4 DDoS Managed Ruleset Read

Transform Rules Write

Transform Rules Read

Select Configuration Write

Select Configuration Read

Account WAF Write

Account WAF Read

Account Rulesets Read

Account Rulesets Write

Logs Write

Logs Read
Get an account entry point rulesetbashcurl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \ --request GET \ --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

View the rules included in a ruleset


You can view all versions of phase entry point rulesets (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 GET request lists the rules in version 2 of the http_request_firewall_managed phase entry point ruleset at the zone level.

Required API token permissions
At least one of the following token permissions is required:
Response Compression Write

Response Compression Read

Config Settings Write

Config Settings Read

Dynamic URL Redirects Write

Dynamic URL Redirects Read

Cache Settings Write

Cache Settings Read

Custom Errors Write

Custom Errors Read

Origin Write

Origin Read

Managed headers Write

Managed headers Read

Zone Transform Rules Write

Zone Transform Rules Read

Mass URL Redirects Write

Mass URL Redirects Read

Magic Firewall Write

Magic Firewall Read

L4 DDoS Managed Ruleset Write

L4 DDoS Managed Ruleset Read

HTTP DDoS Managed Ruleset Write

HTTP DDoS Managed Ruleset Read

Sanitize Write

Sanitize Read

Transform Rules Write

Transform Rules Read

Select Configuration Write

Select Configuration Read

Bot Management Write

Bot Management Read

Zone WAF Write

Zone WAF Read

Account WAF Write

Account WAF Read

Account Rulesets Read

Account Rulesets Write

Logs Write

Logs Read

Logs Write

Logs Read
Get a zone entry point ruleset versionbashcurl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint/versions/2" \ --request GET \ --header "Authorization: Bearer $CLOUDFLARE_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 GET request 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.

Required API token permissions
At least one of the following token permissions is required:
Mass URL Redirects Write

Mass URL Redirects Read

Magic Firewall Write

Magic Firewall Read

L4 DDoS Managed Ruleset Write

L4 DDoS Managed Ruleset Read
…(内容过长已截断)

------
导航页 打开网址