コンテンツにスキップ

ルールセットの一覧と表示

既存のルールセットを一覧表示

アカウントレベルまたはゾーンレベルでの既存のルールセットのリストを返します。

次のAPIエンドポイントのいずれかを使用します：

操作メソッド + エンドポイント
アカウントルールセットを一覧表示GET /accounts/{account_id}/rulesets
ゾーンルールセットを一覧表示GET /zones/{zone_id}/rulesets

結果には、指定されたレベル（アカウントまたはゾーン）でのすべてのフェーズにわたるルールセットが含まれます。各結果要素のphaseフィールドは、そのルールセットが定義されているフェーズを示します。

また、ゾーンレベルのルールセットのリストには、指定されたゾーンにデプロイする可能性のあるアカウントレベルのルールセットが含まれます。

結果には、ルールセット内のルールのリストは含まれていません。ルールのリストを取得する方法については、特定のルールセットを表示を参照してください。

例

リクエスト
Terminal window
curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets \
--header "Authorization: Bearer <API_TOKEN>"

レスポンス

 
{
  "result": [
    {
      "id": "<PHASE_RULESET_ID>",
      "name": "ゾーンレベルのフェーズエントリーポイント",
      "description": "",
      "kind": "zone",
      "version": "5",
      "last_updated": "2023-03-18T18:30:08.122758Z",
      "phase": "http_request_firewall_managed"
    }
  ],
  "success": true,
  "errors": [],
  "messages": []
}

特定のルールセットを表示

指定されたルールセットIDの最新バージョンのプロパティを返します。

次のAPIエンドポイントのいずれかを使用します：

操作メソッド + エンドポイント
アカウントルールセットを取得GET /accounts/{account_id}/rulesets/{ruleset_id}
ゾーンルールセットを取得GET /zones/{zone_id}/rulesets/{ruleset_id}
アカウントエントリーポイントルールセットを取得GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint
ゾーンエントリーポイントルールセットを取得GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint

APIは、次の条件下で404 Not Found HTTPステータスコードを返します：

  • ルールセットが見つからない場合。
  • 指定されたルールセットが、呼び出し元アカウントが実行する権限を持つ管理されたルールセットでない場合。

例

リクエスト
Terminal window
curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
--header "Authorization: Bearer <API_TOKEN>"

レスポンス

 
{
  "result": {
    "id": "<RULESET_ID>",
    "name": "ゾーンレベルのフェーズエントリーポイント",
    "description": "管理されたルールセットを実行します。",
    "kind": "zone",
    "version": "3",
    "rules": [
      {
        "id": "<RULE_ID>",
        "version": "1",
        "action": "execute",
        "expression": "true",
        "action_parameters": {
          "id": "<MANAGED_RULESET_ID>"
        },
        "last_updated": "2023-03-17T15:42:37.917815Z"
      }
    ],
    "last_updated": "2023-03-17T15:42:37.917815Z",
    "phase": "http_request_firewall_managed"
  },
  "success": true,
  "errors": [],
  "messages": []
}

ルールセットのすべてのバージョンを一覧表示

ルールセットのすべてのバージョンのリストを返します。

次のAPIエンドポイントのいずれかを使用します：

操作メソッド + エンドポイント
アカウントルールセットバージョンを一覧表示GET /accounts/{account_id}/rulesets/{ruleset_id}/versions
ゾーンルールセットバージョンを一覧表示GET /zones/{zone_id}/rulesets/{ruleset_id}/versions
アカウントエントリーポイントルールセットバージョンを一覧表示GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions
ゾーンエントリーポイントルールセットバージョンを一覧表示GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions

結果には、各バージョンのルールセットプロパティが含まれますが、ルールのリストは含まれていません。この情報を取得する方法については、特定のルールセットを表示を参照してください。

指定されたフェーズエントリーポイントルールセットが存在しない場合、このAPIメソッドはresultフィールドに空の配列を返します。

例

リクエスト
Terminal window
curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/versions \
--header "Authorization: Bearer <API_TOKEN>"

レスポンス

 
{
  "result": [
    {
      "id": "<RULESET_ID>",
      "name": "ゾーンルールセット 1",
      "description": "",
      "kind": "zone",
      "version": "1",
      "last_updated": "2023-02-17T11:15:13.128705Z",
      "phase": "http_request_firewall_managed"
    },
    {
      "id": "<RULESET_ID>",
      "name": "ゾーンルールセット 1",
      "description": "",
      "kind": "zone",
      "version": "2",
      "last_updated": "2023-02-17T11:24:06.869326Z",
      "phase": "http_request_firewall_managed"
    }
  ],
  "success": true,
  "errors": [],
  "messages": []
}

特定のルールセットのバージョンを表示

特定のルールセットのバージョンの設定を、ルールを含めて返します。

次のAPIエンドポイントのいずれかを使用します：

操作メソッド + エンドポイント
アカウントルールセットバージョンを取得GET /account/{account_id}/rulesets/{ruleset_id}/versions/{version_number}
ゾーンルールセットバージョンを取得GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}
アカウントエントリーポイントルールセットバージョンを取得GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}
ゾーンエントリーポイントルールセットバージョンを取得GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}

指定されたフェーズエントリーポイントルールセットが存在しない場合、このAPIメソッドは404 Not Found HTTPステータスコードを返します。

例

リクエスト
Terminal window
curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number} \
--header "Authorization: Bearer <API_TOKEN>"

レスポンス

 
{
  "result": {
    "id": "<RULESET_ID>",
    "name": "ゾーンレベルのフェーズエントリーポイント",
    "description": "管理されたルールセットを実行します。",
    "kind": "zone",
    "version": "3",
    "rules": [
      {
        "id": "<RULE_ID>",
        "version": "1",
        "action": "execute",
        "expression": "true",
        "action_parameters": {
          "id": "<MANAGED_RULESET_ID>"
        },
        "last_updated": "2023-03-17T15:42:37.917815Z"
      }
    ],
    "last_updated": "2023-03-17T15:42:37.917815Z",
    "phase": "http_request_firewall_managed"
  },
  "success": true,
  "errors": [],
  "messages": []
}

特定のタグを持つ管理されたルールセットのルールを一覧表示

特定のタグを持つ管理されたルールセット内のすべてのルールのリストを返します。

操作メソッド + エンドポイント
タグによるアカウントルールセットバージョン内のルールを一覧表示GET /accounts/{account_id}/rulesets/{managed_ruleset_id}/versions/{version_number}/by_tag/{tag_name}

例

リクエスト
Terminal window
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets/{ruleset_id}/versions/2/by_tag/wordpress \
--header "Authorization: Bearer <API_TOKEN>"

レスポンス

 
{
  "result": {
    "id": "<MANAGED_RULESET_ID>",
    "name": "Cloudflare Managed Ruleset",
    "description": "Cloudflareによって作成された管理されたルールセット",
    "kind": "managed",
    "version": "4",
    "rules": [
      {
        "id": "<RULE_ID_1>",
        "version": "3",
        "action": "log",
        "categories": [
          "cve-2014-5265",
          "cve-2014-5266",
          "cve-2014-5267",
          "dos",
          "drupal",
          "wordpress"
        ],
        "description": "Drupal, WordPress - DoS - XMLRPC - CVE:CVE-2014-5265, CVE:CVE-2014-5266, CVE:CVE-2014-5267",
        "last_updated": "2023-03-19T16:54:32.942986Z",
        "ref": "<RULE_REF_1>",
        "enabled": true
      },
      {
        "id": "<RULE_ID_2>",
        "version": "3",
        "action": "block",
        "categories": ["broken-access-control", "cve-2018-12895", "wordpress"],
        "description": "WordPress - Broken Access Control - CVE:CVE-2018-12895",
        "last_updated": "2023-03-19T16:54:32.942986Z",
        "ref": "<RULE_REF_2>",
        "enabled": true
      }
      // (...)
    ],
    "last_updated": "2023-03-19T16:54:32.942986Z",
    "phase": "http_request_firewall_managed"
  },
  "success": true,
  "errors": [],
  "messages": []
}
Cloudflare DashboardDiscordCommunityLearning CenterSupport Portal
Cookie Settings