INTEGRITY Документация

← Cloudflare Ruleset Engine / ruleset-engine / rulesets-api

Список и просмотр наборов правил

Используйте операции API, описанные в следующих разделах, чтобы получить список наборов правил на уровне аккаунта или зоны и просмотреть их сведения.

Список существующих наборов правил

Возвращает список существующих наборов правил на уровне аккаунта или на уровне зоны.

Используйте одну из следующих конечных точек API:

Результат включает наборы правил всех фаз на заданном уровне (аккаунт или зона). phase поле в каждом элементе результата указывает фаза где определён этот набор правил.

Кроме того, список наборов правил на уровне зоны включает наборы правил уровня аккаунта, которые можно развернуть в указанной зоне.

Результат не включает список правил набора правил. См. Просмотр определённой версии набора правил чтобы узнать, как получить список правил.

Пример

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:
Список наборов правил зоны
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": []
}

Просмотреть конкретный набор правил

Возвращает свойства последней версии набора правил с указанным идентификатором набора правил.

Используйте одну из следующих конечных точек API:

API возвращает 404 Not Found код состояния HTTP при следующих условиях:

Пример

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:
Получить набор правил зоны
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:

Результат содержит свойства набора правил для каждой версии, но не включает список правил. См. Просмотр определённой версии набора правил для инструкций по получению этой информации.

Если указанный входной набор правил фазы не существует, этот метод API возвращает пустой массив в result поле.

Пример

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:
Получить список версий набора правил зоны
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:

Если указанный входной набор правил фазы не существует, этот метод API возвращает 404 Not Found код статуса HTTP.

Пример

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:
Получите версию набора правил зоны
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": []
}

Получить список правил управляемого набора правил с определённым тегом

Возвращает список всех правил управляемого набора правил с указанным тегом.

Пример

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:
Получить список правил версии набора правил аккаунта по тегу
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": []
}