← Cloudflare Ruleset Engine / ruleset-engine / rulesets-api

Aktualizace nebo nasazení rulesetu

K aktualizaci rulesetu použijte jeden z následujících endpointů API:

Aktualizace rulesetu účtu
PUT /accounts/{account_id}/rulesets/{ruleset_id}
Aktualizace rulesetu vstupního bodu účtu
PUT /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint
Aktualizace sady pravidel zóny
PUT /zones/{zone_id}/rulesets/{ruleset_id}
Aktualizace vstupní sady pravidel zóny
PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint

Při aktualizaci rulesetu můžete aktualizovat:

Základní vlastnosti sady pravidel (v současnosti pouze popis)
Seznam pravidel v sadě pravidel

Název sady pravidel ani její typ nelze aktualizovat. Tato pole neuvádějte v data pole vaší PUT požadavek.

Chcete-li nasadit ruleset, přidejte pravidlo s "action": "execute" do seznamu pravidel vstupní sada pravidel. Viz Nasazení sady pravidel pro příklad.

Příklad - Nastavení pravidel sady pravidel

Následující PUT definuje seznam pravidel sady pravidel a nastavuje ji na jedno pravidlo. Do každého požadavku musíte zahrnout všechna pravidla, která chcete se sadou pravidel přidružit.

Požadovaná oprávnění API tokenu

Alespoň jeden z následujících oprávnění tokenu je povinné:

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

Aktualizace sady pravidel zóny

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": []
}

Příklad - Nasazení sady pravidel

Chcete-li nasadit ruleset, vytvořte pravidlo s "action": "execute" , které spouští sadu pravidel, a přidejte ID sady pravidel do action_parameters v id .

Následující PUT nasadí spravovanou sadu pravidel do http_request_firewall_managed fázi zóny ($ZONE_ID).

Požadovaná oprávnění API tokenu

Alespoň jeden z následujících oprávnění tokenu je povinné:

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

Aktualizace vstupní sady pravidel zóny

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": []
}

Další informace o nasazování sad pravidel najdete v Nasazení sad pravidel.

Příklad - Aktualizace popisu sady pravidel

Následující PUT aktualizuje popis existující sady pravidel nebo vstupního bodu fáze.

Odpověď bude obsahovat kompletní definici sady pravidel včetně všech pravidel.

Požadovaná oprávnění API tokenu

Alespoň jeden z následujících oprávnění tokenu je povinné:

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

Aktualizace sady pravidel zóny

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": []
}