使用 Rulesets API 通过 API 创建配置规则。
通过 API 创建配置规则时,请确保:
- 将规则操作设为
set_config。 - 根据你希望为匹配请求覆盖的 设置,在
action_parameters字段中定义参数。 - 将规则部署到 zone 级别的
http_config_settings阶段。
通过 API 为给定 zone 创建 a configuration rule 时,请遵循以下工作流:
使用 List zone rulesets 操作检查 zone 级别是否已有
http_config_settingsphase 的 ruleset。-
如果 phase ruleset 不存在,使用 Create a zone ruleset 操作创建。在新 ruleset 属性中设置以下值:
- kind:
zone - phase:
http_config_settings
- kind:
使用 Update a zone ruleset 操作将 a configuration rule 添加到 ruleset 规则列表。或者,在上一步的 Create a zone ruleset 请求中包含该规则。
请确保你的 API 令牌具有执行 API 操作所需的 权限。
示例:添加启用邮件地址混淆和浏览器完整性检查的规则
以下示例使用 Update a zone ruleset 操作,将现有阶段规则集({ruleset_id})的规则设为单条配置规则——为联系页面启用 Email Obfuscation 与 Browser Integrity Check:
Required API token permissions
At least one of the following token permissions is required:Response Compression WriteConfig Settings WriteDynamic URL Redirects WriteCache Settings WriteCustom Errors WriteOrigin WriteManaged headers WriteZone Transform Rules WriteMass URL Redirects WriteMagic Firewall WriteL4 DDoS Managed Ruleset WriteHTTP DDoS Managed Ruleset WriteSanitize WriteTransform Rules WriteSelect Configuration WriteBot Management WriteZone WAF WriteAccount WAF WriteAccount Rulesets WriteLogs WriteLogs Write
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
}
}
]
}'使用 Terraform 时,通过 ref 字段使规则 ID 在更新之间保持稳定。添加此字段可防止 Terraform 在发生变更时重新创建规则。更多信息请参阅 Terraform 文档中的故障排除。
示例:添加为管理区域启用 Under Attack 模式的规则
以下示例使用 Update a zone ruleset 操作,将现有阶段规则集({ruleset_id})的规则设为单条配置规则——为管理区域开启 Under Attack 模式:
Required API token permissions
At least one of the following token permissions is required:Response Compression WriteConfig Settings WriteDynamic URL Redirects WriteCache Settings WriteCustom Errors WriteOrigin WriteManaged headers WriteZone Transform Rules WriteMass URL Redirects WriteMagic Firewall WriteL4 DDoS Managed Ruleset WriteHTTP DDoS Managed Ruleset WriteSanitize WriteTransform Rules WriteSelect Configuration WriteBot Management WriteZone WAF WriteAccount WAF WriteAccount Rulesets WriteLogs WriteLogs Write
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"
}
}
]
}'使用 Terraform 时,通过 ref 字段使规则 ID 在更新之间保持稳定。添加此字段可防止 Terraform 在发生变更时重新创建规则。更多信息请参阅 Terraform 文档中的故障排除。
用于管理配置规则的 API 请求中使用的 API 令牌至少需要具备以下权限:
- Zone > 配置规则 > 编辑