跳转到内容
搜索文档

更新或部署规则集

最后更新 查看 MarkdownAgent 设置

使用以下某个 API 端点更新规则集:

更新规则集时,可以更新:

  • 规则集的基本属性(目前仅限描述)
  • 规则集中的规则列表

无法更新规则集的名称或其类型。请勿在 PUT 请求的 data 字段中包含这些字段。

要部署规则集,请向入口点规则集的规则列表添加一条 "action": "execute" 的规则。示例请参阅部署规则集

示例 - 设置规则集的规则

以下 PUT 请求定义规则集的规则列表,将其设置为单条规则。每次请求都必须包含要与该规则集关联的所有规则。

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 rulesetbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"rules": [
				{
						"action": "execute",
						"action_parameters": {
								"id": "<MANAGED_RULESET_ID>"
						},
						"expression": "true"
				}
		]
	}'
{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point ruleset",
		"description": "This ruleset executes 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": "2025-03-17T15:42:37.917815Z"
			}
		],
		"last_updated": "2025-03-17T15:42:37.917815Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

示例 - 部署规则集

要部署规则集,请创建一条 "action": "execute" 的规则来执行该规则集,并将规则集 ID 添加到 action_parameters 字段中的 id 参数。

以下 PUT 请求将托管规则集部署到某个 zone($ZONE_ID)的 http_request_firewall_managed 阶段。

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": "<MANAGED_RULESET_ID>"
						},
						"expression": "true",
						"description": "Execute Cloudflare Managed Ruleset on my phase entry point ruleset"
				}
		]
	}'
{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point 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 entry point ruleset",
				"last_updated": "2025-03-21T11:02:08.769537Z",
				"ref": "<RULE_REF_1>",
				"enabled": true
			}
		],
		"last_updated": "2025-03-21T11:02:08.769537Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

有关部署规则集的更多信息,请参阅部署规则集

示例 - 更新规则集描述

以下 PUT 请求更新现有规则集或阶段入口点的描述。

响应将包含完整的规则集定义,包括所有规则。

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 rulesetbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"description": "My updated phase entry point ruleset"
	}'
{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone entry point",
		"description": "My updated phase entry point ruleset",
		"kind": "zone",
		"version": "4",
		"rules": [
			// (...)
		],
		"last_updated": "2025-03-30T10:49:11.006109Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

这篇文档对您有帮助吗?