← Документация WAF / custom-rules / skip
Примеры API
Используйте Rulesets API чтобы настраивать пользовательские правила через API.
skip действие поддерживает разные варианты пропуска, в зависимости от того, какие функции или продукты безопасности вы хотите пропустить.
Прежде чем продолжить
На этой странице приведены примеры различных сценариев использования правил пропуска для пользовательских правил. Учитывайте следующее:
-
$ZONE_IDзначением является ID зоны куда вы хотите добавить правило. -
$RULESET_IDзначением является ID ruleset точки входа изhttp_request_firewall_customфаза. Подробнее о получении ID этого набора правил см. в разделе Список и просмотр наборов правил. Примеры API на этой странице добавляют правило пропуска в существующий набор правил с помощью Создание правила набора правил зоны операцию.Однако входной набор правил может ещё не существовать. В этом случае вызовите Создание набора правил зоны операцию для создания входного набора правил с правилом пропуска. См. Создание набора правил для примера.
-
Хотя в каждом примере указан только один параметр действия, в одном правиле можно использовать несколько параметров пропуска, указав
ruleset,phases, а такжеproductsпараметры действия одновременно.
Пропустить оставшиеся правила в текущем наборе правил
В этом примере вызывается Создание правила набора правил зоны операцию для добавления правила пропуска в существующий 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": ""
}'См. Доступные варианты пропуска список фаз, которые можно пропустить.
Пропустить фазу и не записывать в журнал совпадающие запросы
В этом примере вызывается Создание правила набора правил зоны операцию для добавления правила, которое:
- Пропускает
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": ""
}'См. Доступные варианты пропуска список продуктов, которые можно пропустить.
Пропустить оставшиеся правила в текущей фазе
В этом примере вызывается Создание правила набора правил зоны операцию для добавления правила пропуска в существующий 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": ""
}'В настоящее время этот вариант пропуска доступен только на уровне зоны. См. Доступные варианты пропуска для дополнительных сведений.