← Cloudflare Rules / rules / configuration-rules

Vytvořte konfigurační pravidlo přes API

Použijte Rulesets API k vytváření konfiguračních pravidel přes API.

Základní nastavení pravidla

Při vytváření configuration rule přes API se ujistěte, že:

Nastavte akci pravidla na set_config.
Definujte parametry v action_parameters pole podle nastavení které chcete přepsat pro odpovídající požadavky.
Nasaďte pravidlo do http_config_settings fázi na úrovni zóny.

Postup

Konfigurační pravidlo vytvoříte pro danou zónu přes API podle tohoto postupu:

Použijte Seznam sad pravidel zóny operaci pro kontrolu, zda již existuje ruleset pro http_config_settings fázi na úrovni zóny.
Pokud fázový ruleset neexistuje, vytvořte jej pomocí Vytvoření rulesetu zóny operace. Ve vlastnostech nového rulesetu nastavte následující hodnoty:
- typ: zone
- fáze: http_config_settings
Použijte Aktualizace sady pravidel zóny operaci pro přidání konfiguračního pravidla do seznamu pravidel rulesetu. Případně můžete pravidlo zahrnout do Vytvoření rulesetu zóny požadavek uvedený v předchozím kroku.

Ujistěte se, že váš API token má oprávnění požadovaná oprávnění k provádění operací API.

Příklady požadavků

Příklad: Přidání pravidla, které povolí Email Obfuscation a Browser Integrity Check

Následující příklad nastavuje pravidla existující sady pravidel fáze ({ruleset_id}) do jediného konfiguračního pravidla, které pro stránku kontaktů zapíná funkce Email Obfuscation a Browser Integrity Check pomocí Aktualizace sady pravidel zóny operace:

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": [
				{
						"ref": "enable_email_obfuscation_bic",
						"expression": "starts_with(http.request.uri.path, \"/contact-us/\")",
						"description": "Obfuscates email addresses and enables BIC in contacts page",
						"action": "set_config",
						"action_parameters": {
								"email_obfuscation": true,
								"bic": true
						}
				}
		]
	}'

Použijte ref pole, abyste při použití Terraformu měli stabilní ID pravidel napříč aktualizacemi. Přidání tohoto pole zabrání tomu, aby Terraform při změnách pravidlo vytvářel znovu. Další informace najdete v Řešení potíží v dokumentaci Terraform.

Příklad: Přidání pravidla, které zapne režim Under Attack pro administrační sekci

Následující příklad nastavuje pravidla existující sady pravidel fáze ({ruleset_id}) do jediného konfiguračního pravidla, které pro administrační oblast aktivuje Under Attack Mode pomocí Aktualizace sady pravidel zóny operace:

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": [
				{
						"ref": "enable_under_attack_in_admin",
						"expression": "http.host eq \"admin.example.com\"",
						"description": "Turn on Under Attack mode for admin area",
						"action": "set_config",
						"action_parameters": {
								"security_level": "under_attack"
						}
				}
		]
	}'

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

API token použitý v API požadavcích pro správu configuration rules musí mít alespoň následující oprávnění:

Zóna > Config Rules > Úprava