APIを介して作成する

Rulesets APIを使用して、APIを介してカスタムルールを作成します。

カスタムルールは、http_request_firewall_custom フェーズエントリーポイントルールセットにデプロイする必要があります。

カスタムルールを作成する

To create a custom rule for a zone, add a rule to the http_request_firewall_custom phase entry point ruleset.

1. Invoke the List zone rulesets method to obtain the list of rulesets in your zone. You will need the zone ID for this operation.

2. Search for an entry point ruleset for the http_request_firewall_custom phase in the response. Such a ruleset would have the following properties: "kind": "zone" and “phase”: "http_request_firewall_custom". If you find the ruleset, take note of its ID for the next step.

3. If the entry point ruleset already exists, invoke the Create a zone ruleset rule operation to add a custom rule to the existing ruleset. By default, the rule will be added at the end of the list of rules already in the ruleset. Refer to the examples below for details.

   If the entry point ruleset does not exist, invoke the Create a zone ruleset operation to create the entry point ruleset with the new custom rule. Refer to Create ruleset for an example.

例 A

この例のリクエストは、ルール作成手順のステップ3をカバーしており、IDが{zone_id}のゾーンに対して、http_request_firewall_customフェーズエントリーポイントルールセットにルールを追加します。エントリーポイントルールセットはすでに存在し、IDは{ruleset_id}です。

新しいルールは、ルールセットの最後のルールとなり、イギリスまたはフランスからのリクエストに対して、脅威スコアが10を超える場合にチャレンジします：

curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/rules \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "description": "私のカスタムルール",
  "expression": "(ip.geoip.country eq \"GB\" or ip.geoip.country eq \"FR\") and cf.threat_score > 10",
  "action": "challenge"
}'

To define a specific position for the new rule, include a position object in the request body according to the guidelines in Change the order of a rule in a ruleset.

For instructions on creating an entry point ruleset and defining its rules using a single API call, refer to Add rules to phase entry point rulesets.

例 B

この例のリクエストは、ルール作成手順のステップ3をカバーしており、IDが{zone_id}のゾーンに対して、http_request_firewall_customフェーズエントリーポイントルールセットにルールを追加します。エントリーポイントルールセットはすでに存在し、IDは{ruleset_id}です。

新しいルールは、ルールセットの最後のルールとなり、ブロックされたリクエストに対するカスタムレスポンスの定義を含みます：

curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/rules \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '{
  "description": "プレーンテキストレスポンスを持つ私のカスタムルール",
  "expression": "(ip.geoip.country eq \"GB\" or ip.geoip.country eq \"FR\") and cf.threat_score > 50",
  "action": "block",
  "action_parameters": {
    "response": {
      "status_code": 403,
      "content": "あなたのリクエストはブロックされました。",
      "content_type": "text/plain"
    }
  }
}'

To define a specific position for the new rule, include a position object in the request body according to the guidelines in Change the order of a rule in a ruleset.

For instructions on creating an entry point ruleset and defining its rules using a single API call, refer to Add rules to phase entry point rulesets.

---

次のステップ

Rulesets APIのさまざまな操作を使用して、作成したルールを操作します。以下の表には、一般的なタスクのリストがあります：

Task	Procedure
List all rules in ruleset	Use the Get a zone entry point ruleset operation with the http_request_firewall_custom phase name to obtain the list of configured custom rules and their IDs. For more information, refer to View a specific ruleset.
Update a rule	Use the Update a zone ruleset rule operation. You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the Get a zone entry point ruleset operation with the http_request_firewall_custom phase name. For more information, refer to Update a rule in a ruleset.
Delete a rule	Use the Delete a zone ruleset rule operation. You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the Get a zone entry point ruleset operation with the http_request_firewall_custom phase name. For more information, refer to Delete a rule in a ruleset.

These operations are covered in the Ruleset Engine documentation. The Ruleset Engine powers different Cloudflare products, including custom rules.