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

次の各節の API 操作を使い、アカウントまたはゾーンレベルでルールセットの一覧と詳細を取得します。

既存のルールセットを一覧する
特定のルールセットを表示する
ルールセットの全バージョンを一覧する
ルールセットの特定バージョンを表示する
マネージドルールセット内の特定タグのルールを一覧する

既存のルールセットを一覧する

アカウントレベルまたはゾーンレベルにある既存ルールセットの一覧を返します。

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

アカウントのルールセットを一覧する
GET /accounts/{account_id}/rulesets
ゾーンのルールセットを一覧する
GET /zones/{zone_id}/rulesets

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

また、ゾーンレベルのルールセット一覧には、指定ゾーンへデプロイできるアカウントレベルのルールセットも含まれます。

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

例

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": "<PHASE_RULESET_ID>",
			"name": "Zone-level phase entry point",
			"description": "",
			"kind": "zone",
			"version": "5",
			"last_updated": "2025-03-18T18:30:08.122758Z",
			"phase": "http_request_firewall_managed"
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

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

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

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

アカウントのルールセットを取得する
GET /accounts/{account_id}/rulesets/{ruleset_id}
アカウントのエントリポイントルールセットを取得する
GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint
ゾーンのルールセットを取得する
GET /zones/{zone_id}/rulesets/{ruleset_id}
ゾーンのエントリポイントルールセットを取得する
GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint

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

ルールセットが見つからないとき。
指定したルールセットが、呼び出し元アカウントに実行権限のないマネージドルールセットであるとき。

例

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 rulesetbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point",
		"description": "Executes a managed ruleset.",
		"kind": "zone",
		"version": "3",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "execute",
				"expression": "true",
				"action_parameters": {
					"id": "<MANAGED_RULESET_ID>"
				},
				"last_updated": "2025-03-17T15:42:37.917815Z"
			}
		],
		"last_updated": "2025-03-17T15:42:37.917815Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

ルールセットの全バージョンを一覧する

ルールセットの全バージョンの一覧を返します。

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

アカウントルールセットのバージョンを一覧する
GET /accounts/{account_id}/rulesets/{ruleset_id}/versions
アカウントのエントリポイントルールセットのバージョンを一覧する
GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions
ゾーンルールセットのバージョンを一覧する
GET /zones/{zone_id}/rulesets/{ruleset_id}/versions
ゾーンのエントリポイントルールセットのバージョンを一覧する
GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions

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

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

例

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 a zone ruleset's versionsbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/versions" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
	"result": [
		{
			"id": "<RULESET_ID>",
			"name": "Zone Ruleset 1",
			"description": "",
			"kind": "zone",
			"version": "1",
			"last_updated": "2023-02-17T11:15:13.128705Z",
			"phase": "http_request_firewall_managed"
		},
		{
			"id": "<RULESET_ID>",
			"name": "Zone Ruleset 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 /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}
ゾーンルールセットのバージョンを取得する
GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}
ゾーンのエントリポイントルールセットのバージョンを取得する
GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}

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

例

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 ruleset versionbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/versions/$RULESET_VERSION" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Zone-level phase entry point",
		"description": "Executes a managed ruleset.",
		"kind": "zone",
		"version": "<RULESET_VERSION>",
		"rules": [
			{
				"id": "<RULE_ID>",
				"version": "1",
				"action": "execute",
				"expression": "true",
				"action_parameters": {
					"id": "<MANAGED_RULESET_ID>"
				},
				"last_updated": "2025-03-17T15:42:37.917815Z"
			}
		],
		"last_updated": "2025-03-17T15:42:37.917815Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}

マネージドルールセット内の特定タグのルールを一覧する

マネージドルールセット内で、特定タグを持つルールの一覧を返します。

アカウントルールセットのバージョンのルールをタグで一覧する
GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}/by_tag/{tag_name}

例

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 an account ruleset version's rules by tagbash

curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rulesets/$RULESET_ID/versions/2/by_tag/wordpress" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
	"result": {
		"id": "<MANAGED_RULESET_ID>",
		"name": "Cloudflare Managed Ruleset",
		"description": "Managed ruleset created by Cloudflare",
		"kind": "managed",
		"version": "2",
		"rules": [
			{
				"id": "<RULE_ID_1>",
				"version": "2",
				"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": "2025-03-19T16:54:32.942986Z",
				"ref": "<RULE_REF_1>",
				"enabled": true
			},
			{
				"id": "<RULE_ID_2>",
				"version": "2",
				"action": "block",
				"categories": ["broken-access-control", "cve-2018-12895", "wordpress"],
				"description": "WordPress - Broken Access Control - CVE:CVE-2018-12895",
				"last_updated": "2025-03-19T16:54:32.942986Z",
				"ref": "<RULE_REF_2>",
				"enabled": true
			}
			// (...)
		],
		"last_updated": "2025-03-19T16:54:32.942986Z",
		"phase": "http_request_firewall_managed"
	},
	"success": true,
	"errors": [],
	"messages": []
}