Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

ルールセットを表示する

最終更新 Markdown で表示Agent セットアップ

このページには、次の API 操作の例があります。

利用できるルールセットを表示する

ゾーンまたはアカウントで利用できるルールセットを一覧できます。

API エンドポイントの一覧は ルールセットの一覧と表示 を参照してください。

例: ゾーンレベルで利用できるルールセットを表示する

ゾーンレベルでルールセット一覧を取得する GET リクエスト のレスポンスには、次のルールセットが含まれます。

  • デプロイできるマネージドルールセット。"kind": "managed" で示されます。
  • ゾーンレベルのフェーズエントリポイントルールセット（設定済みの場合）。"kind": "zone" で示されます。
  • カスタムルールセット（設定済みの場合）。"kind": "custom" で示されます。

Required API token permissions

At least one of the following token permissions is required:
  • Response Compression Write
  • Response Compression Read
  • Config Settings Write
  • Config Settings Read
  • Dynamic URL Redirects Write
  • Dynamic URL Redirects Read
  • Cache Settings Write
  • Cache Settings Read
  • Custom Errors Write
  • Custom Errors Read
  • Origin Write
  • Origin Read
  • Managed headers Write
  • Managed headers Read
  • Zone Transform Rules Write
  • Zone Transform Rules Read
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • HTTP DDoS Managed Ruleset Write
  • HTTP DDoS Managed Ruleset Read
  • Sanitize Write
  • Sanitize Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Bot Management Write
  • Bot Management Read
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
  • Logs Write
  • Logs Read
List zone rulesetsbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": [
		{
			"id": "<ZONE_PHASE_RULESET_ID>",
			"name": "Zone-level Ruleset 1",
			"description": "Ruleset for http_request_firewall_managed phase at the zone level",
			"kind": "zone",
			"version": "2",
			"last_updated": "2021-03-12T14:11:59.754817Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_MANAGED_RULESET_ID>",
			"name": "Cloudflare Managed Ruleset",
			"description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives",
			"kind": "managed",
			"version": "2",
			"last_updated": "2021-03-18T14:42:40.972022Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_OWASP_CORE_RULESET_ID>",
			"name": "Cloudflare OWASP Core Ruleset",
			"description": "Cloudflare's implementation of the Open Web Application Security Project (OWASP) ModSecurity Core Rule Set. We routinely monitor for updates from OWASP based on the latest version available from the official code repository",
			"kind": "managed",
			"version": "3",
			"last_updated": "2021-03-18T14:42:42.993211Z",
			"phase": "http_request_firewall_managed"
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

例: アカウントレベルで利用できるルールセットを表示する

アカウントレベルでルールセット一覧を取得する GET リクエスト のレスポンスには、次のルールセットが含まれます。

  • デプロイできるマネージドルールセット。"kind": "managed" で示されます。
  • アカウントレベルのフェーズエントリポイントルールセット（設定済みの場合）。"kind": "root" で示されます。
  • カスタムルールセット（設定済みの場合）。"kind": "custom" で示されます。

Required API token permissions

At least one of the following token permissions is required:
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
List account rulesetsbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": [
		{
			"id": "<CUSTOM_RULESET_ID>",
			"name": "Custom Ruleset 1",
			"description": "My custom ruleset",
			"kind": "custom",
			"version": "10",
			"last_updated": "2020-11-23T11:36:24.192361Z",
			"phase": "http_request_firewall_custom"
		},
		{
			"id": "<ACCOUNT_PHASE_RULESET_ID>",
			"name": "Account-level ruleset for http_request_firewall_managed phase",
			"description": "Account-level ruleset for executing one or more Managed Rulesets",
			"kind": "root",
			"version": "2",
			"last_updated": "2021-03-12T14:06:41.323932Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_MANAGED_RULESET_ID>",
			"name": "Cloudflare Managed Ruleset",
			"description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives",
			"kind": "managed",
			"version": "5",
			"last_updated": "2021-03-18T14:42:40.972022Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<CLOUDFLARE_OWASP_CORE_RULESET_ID>",
			"name": "Cloudflare OWASP Core Ruleset",
			"description": "Cloudflare's implementation of the Open Web Application Security Project (OWASP) ModSecurity Core Rule Set. We routinely monitor for updates from OWASP based on the latest version available from the official code repository",
			"kind": "managed",
			"version": "3",
			"last_updated": "2021-03-18T14:42:42.993211Z",
			"phase": "http_request_firewall_managed"
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

エントリポイントルールセットを取得する

ゾーンまたはアカウントレベルで、指定 フェーズ の エントリポイントルールセット の定義を取得できます。

エントリポイントルールセットがある場合、API は 200 OK HTTP ステータスコードと、ルールセット定義を返します。

エントリポイントルールセットがない場合、API は 404 Not Found HTTP ステータスコードを返します。

例: ゾーンレベルでエントリポイントルールセットを取得する

次の GET リクエスト は、ゾーンレベルで http_request_firewall_managed フェーズのエントリポイントルールセット定義を取得します。この場合、エントリポイントルールセットは存在し、ルールを 1 件含みます。

Required API token permissions

At least one of the following token permissions is required:
  • Response Compression Write
  • Response Compression Read
  • Config Settings Write
  • Config Settings Read
  • Dynamic URL Redirects Write
  • Dynamic URL Redirects Read
  • Cache Settings Write
  • Cache Settings Read
  • Custom Errors Write
  • Custom Errors Read
  • Origin Write
  • Origin Read
  • Managed headers Write
  • Managed headers Read
  • Zone Transform Rules Write
  • Zone Transform Rules Read
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • HTTP DDoS Managed Ruleset Write
  • HTTP DDoS Managed Ruleset Read
  • Sanitize Write
  • Sanitize Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Bot Management Write
  • Bot Management Read
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
  • Logs Write
  • Logs Read
Get a zone entry point rulesetbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point ruleset",
		"description": "This ruleset executes a managed ruleset.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "execute",
				"expression": "true",
				"action_parameters": {
					"id": "<MANAGED_RULESET_ID>"
				},
				"last_updated": "2021-03-17T15:42:37.917815Z"
			}
		],
		"last_updated": "2021-03-17T15:42:37.917815Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

例: アカウントレベルでエントリポイントルールセットを取得する

次の GET リクエスト は、アカウントレベルで http_request_firewall_managed フェーズのエントリポイントルールセット定義を取得します。

Required API token permissions

At least one of the following token permissions is required:
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
Get an account entry point rulesetbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

ルールセットに含まれるルールを表示する

フェーズのエントリポイントルールセット（アカウントおよびゾーンレベル）とカスタムルールセットは、すべてのバージョンを表示できます。マネージドルールセットは、最新バージョンのみ表示できます。

例: ゾーンレベルでフェーズのエントリポイントルールセット内のルールを表示する

次の GET リクエスト は、ゾーンレベルで http_request_firewall_managed フェーズのエントリポイントルールセットのバージョン 2 に含まれるルールを一覧します。

Required API token permissions

At least one of the following token permissions is required:
  • Response Compression Write
  • Response Compression Read
  • Config Settings Write
  • Config Settings Read
  • Dynamic URL Redirects Write
  • Dynamic URL Redirects Read
  • Cache Settings Write
  • Cache Settings Read
  • Custom Errors Write
  • Custom Errors Read
  • Origin Write
  • Origin Read
  • Managed headers Write
  • Managed headers Read
  • Zone Transform Rules Write
  • Zone Transform Rules Read
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • HTTP DDoS Managed Ruleset Write
  • HTTP DDoS Managed Ruleset Read
  • Sanitize Write
  • Sanitize Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Bot Management Write
  • Bot Management Read
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
  • Logs Write
  • Logs Read
Get a zone entry point ruleset versionbash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint/versions/2" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point ruleset",
		"description": "This ruleset executes a managed ruleset.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "execute",
				"expression": "true",
				"action_parameters": {
					"id": "<MANAGED_RULESET_ID>"
				},
				"last_updated": "2021-03-17T15:42:37.917815Z"
			}
		],
		"last_updated": "2021-03-17T15:42:37.917815Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

例: マネージドルールセット内のルールを表示する

次の GET リクエスト は、マネージドルールセットのバージョン 2（そのルールセットの最新バージョン）に含まれるルールを一覧します。

マネージドルールセット内の各ルールは、関連するタグまたはカテゴリを持てます。categories フィールドに一覧されます。

Required API token permissions

At least one of the following token permissions is required:
  • Mass URL Redirects Write
  • Mass URL Redirects Read
  • Magic Firewall Write
  • Magic Firewall Read
  • L4 DDoS Managed Ruleset Write
  • L4 DDoS Managed Ruleset Read
  • Transform Rules Write
  • Transform Rules Read
  • Select Configuration Write
  • Select Configuration Read
  • Account WAF Write
  • Account WAF Read
  • Account Rulesets Read
  • Account Rulesets Write
  • Logs Write
  • Logs Read
Get an account ruleset versionbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets/$MANAGED_RULESET_ID/versions/2" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": {
		"id": "<MANAGED_RULESET_ID>",
		"name": "Cloudflare Managed Ruleset",
		"description": "Created by the Cloudflare security team, this ruleset is designed to provide fast and effective protection for all your applications. It is frequently updated to cover new vulnerabilities and reduce false positives",
		"kind": "managed",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_1_ID>",
				"version": "1",
				"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": "2021-03-18T14:42:40.972022Z",
				"ref": "<RULE_1_REF>",
				"enabled": true
			},
			{
				"id": "<RULE_2_ID>",
				"version": "1",
				"action": "block",
				"categories": ["broken-access-control", "cve-2018-12895", "wordpress"],
				"description": "Wordpress - Broken Access Control - CVE:CVE-2018-12895",
				"last_updated": "2021-03-18T14:42:40.972022Z",
				"ref": "<RULE_2_REF>",
				"enabled": true
			}
			// (...)
		],
		"last_updated": "2021-03-18T14:42:40.972022Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

関連リソース

ルールセット表示向けの API メソッドの詳細は ルールセットの一覧と表示 を参照してください。

役に立ちましたか？