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

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

Объекты JSON

На этой странице описаны объекты JSON, используемые в запросах API для создания или обновления наборов правил и их правил через Rulesets API, а также объекты, возвращаемые API.

Объект Ruleset

Полностью заполненный объект набора правил имеет следующую структуру JSON.

{
	"id": "6a359df138c442b385d20140d4d96919",
	"name": "Example Ruleset",
	"description": "Description of Example Ruleset",
	"kind": "custom",
	"version": "2",
	"phase": "http_request_firewall_custom",
	"rules": [
		{
			"id": "fdb0dd271f3f40b19679cc5d91396024",
			"version": "2",
			"action": "block",
			"expression": "cf.zone.name eq \"example.com\" ",
			"last_updated": "2022-07-20T10:44:29.124515Z"
		}
	],
	"last_updated": "2022-07-20T10:44:29.124515Z"
}

Сведения о свойствах элементов массива rules см. в rules массиве см. в Структура и свойства объекта Rule раздел.

Свойства

Объект набора правил содержит следующие свойства:

Структура и свойства объекта Rule

Полностью заполненный JSON-объект правила имеет следующую структуру:

{
	"id": "fdb0dd271f3f40b19679cc5d91396024",
	"version": "2",
	"ref": "<REF>",
	"description": "<DESCRIPTION>",
	"action": "block",
	"action_parameters": [
		// action parameters vary according to the action
	],
	"categories": ["<CATEGORY_1>", "<CATEGORY_2>"],
	"expression": "cf.zone.name eq \"example.com\"",
	"last_updated": "2025-07-20T10:44:29.124515Z",
	"enabled": true
}

Свойства JSON-объекта для правила определяются следующим образом: