← Документация WAF / custom-rules / skip

Примеры API

Используйте Rulesets API для настройки пользовательских правил через API.

skip действие поддерживает разные параметры пропуска, в зависимости от функций безопасности или продуктов, которые вы хотите пропустить.

На этой странице приведены примеры различных сценариев правил пропуска (skip) для пользовательских правил. Учитывайте следующее:

• $ZONE_ID — это Идентификатор зоны, куда вы хотите добавить правило.

• $RULESET_ID — это ID набор правил точки входа http_request_firewall_custom фазы. О том, как получить идентификатор этого набора правил, см. Просмотр и вывод списка наборов правил. Примеры API на этой странице добавляют правило пропуска в существующий набор правил с помощью Создание правила в наборе правил зоны (операция API).

  Однако набор правил точки входа может ещё не существовать. В этом случае вызовите Создание набора правил зоны операцию, чтобы создать набор правил точки входа с правилом пропуска. См. Create ruleset для примера.

• Хотя каждый пример включает только один параметр действия, вы можете использовать несколько вариантов пропуска (skip) в одном правиле, указав ruleset, phases и products параметры действия одновременно.

Этот пример вызывает Создание правила в наборе правил зоны операцию, чтобы добавить правило пропуска (skip) в существующий http_request_firewall_custom (набор правил точки входа фазы) с ID $RULESET_ID. Правило пропустит все остальные правила текущего набора для запросов, соответствующих выражению правила.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/rules" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"action": "skip",
		"action_parameters": {
				"ruleset": "current"
		},
		"expression": "http.request.uri.path contains \"/skip-current-ruleset/\"",
		"description": ""
	}'

Этот пример вызывает Создание правила в наборе правил зоны, чтобы добавить правило в существующий http_request_firewall_custom (набор правил точки входа фазы) с ID $RULESET_ID. Правило пропустит http_ratelimit для запросов, соответствующих выражению правила.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/rules" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"action": "skip",
		"action_parameters": {
				"phases": [
						"http_ratelimit"
				]
		},
		"expression": "http.request.uri.path contains \"/skip-phase/\"",
		"description": ""
	}'

См. Доступные варианты пропуска (skip) со списком фаз, которые можно пропустить.

Этот пример вызывает Создание правила в наборе правил зоны, чтобы добавить правило, которое:

• Пропускает http_ratelimit фазе
• Отключает логирование событий для текущего правила

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/rules" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"action": "skip",
		"action_parameters": {
				"phases": [
						"http_ratelimit"
				]
		},
		"logging": {
				"enabled": false
		},
		"expression": "http.request.uri.path contains \"/disable-logging/\"",
		"description": ""
	}'

См. Доступные варианты пропуска (skip) о том, как отключить журналирование запросов, соответствующих правилу пропуска.

Этот пример использует Создание правила в наборе правил зоны, чтобы добавить правило, пропускающее Zone Lockdown и User Agent Blocking продукты для запросов, соответствующих выражению правила.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/rules" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"action": "skip",
		"action_parameters": {
				"products": [
						"zoneLockdown",
						"uaBlock"
				]
		},
		"expression": "http.request.uri.path contains \"/skip-products/\"",
		"description": ""
	}'

См. Доступные варианты пропуска (skip) со списком продуктов, которые можно пропустить.

Этот пример вызывает Создание правила в наборе правил зоны операцию, чтобы добавить правило пропуска (skip) в существующий http_request_firewall_custom (набор правил точки входа фазы) с ID $RULESET_ID. Правило пропустит все остальные правила в http_request_firewall_custom для запросов, соответствующих выражению правила.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/rules" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"action": "skip",
		"action_parameters": {
				"phase": "current"
		},
		"expression": "http.request.uri.path contains \"/skip-current-ruleset/\"",
		"description": ""
	}'

В настоящее время этот вариант пропуска доступен только на уровне зоны. См. Доступные варианты пропуска (skip) для получения дополнительных сведений.