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

Objekty JSON

Tato stránka popisuje objekty JSON používané v požadavcích API při vytváření nebo aktualizaci sad pravidel a jejich pravidel prostřednictvím Rulesets API, a také objekty vracené tímto API.

Plně vyplněný objekt rulesetu má následující strukturu 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"
}

Podrobnosti o vlastnostech položek pravidel v rules pole, viz Struktura a vlastnosti objektu pravidla sekce.

Objekt sady pravidel má následující vlastnosti:

• id String

  • Řetězec UUIDv4 o délce 32 znaků, který představuje jedinečný identifikátor dané verze rulesetu vygenerovaný Cloudflare.
  • Jedinečné, pouze pro čtení.

• name String

  • Název rulesetu srozumitelný pro člověka.
  • Název je neměnný. Po celou dobu existence sady pravidel jej nelze změnit.

• description String

  • Volitelný popis sady pravidel.
  • Popis sady pravidel můžete v průběhu jejího životního cyklu změnit.

• kind String

  • Druh sady pravidel, který objekt JSON reprezentuje.
  • Jedna z root, zone, managed, custom.
  • kind je neměnné.

• version Integer

  • Verze sady pravidel.
  • Hodnota pouze pro čtení začínající na 1 a zvýšeno o 1 při každé úpravě sady pravidel.

• rules Array<Rule>

  • Seznam pravidel, která se mají zahrnout do rulesetu. Viz Struktura a vlastnosti objektu pravidla s podrobnostmi.

• last_updated Timestamp

  • Čas (UTC), kdy byla sada pravidel naposledy aktualizována, ve formátu ISO 8601: YYYY-MM-DDThh:mm:ss.TZD.
  • Pouze pro čtení.

Plně vyplněný objekt JSON pravidla má následující strukturu:

{
	"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
}

Vlastnosti objektu JSON pro pravidlo jsou definovány takto:

• id String

  • Řetězec UUIDv4 o délce 32 znaků, který představuje jedinečný identifikátor dané verze pravidla vygenerovaný Cloudflare.
  • Jedinečné, pouze pro čtení.

• version Integer

  • Verze pravidla.
  • Hodnota pouze pro čtení začínající na 1 a zvýšeno o 1 při každé úpravě pravidla.
  • Změna pořadí pravidla v sadě pravidel nemění jeho verzi.

• ref String

  • Uživatelem definovaný externí identifikátor, který musí být jedinečný pro každé pravidlo v sadě pravidel.
  • Toto pole použijte v konfiguraci Terraformu, abyste zabránili tomu, že Terraform při změnách pravidlo znovu vytvoří. Přečtěte si Jak zachovat stejné ID pravidla mezi úpravami s dalšími informacemi.

• description String

  • Popisný název pravidla.

• action String

  • Definuje, co se stane, pokud dojde ke shodě s výrazem pravidla.
  • Dostupné akce závisí na fáze kde se sada pravidel daného pravidla spouští.

• action_parameters Object

  • Jeden nebo více parametrů konfigurujících akci pravidla.
  • Přesné vlastnosti se liší podle akce. Další informace najdete v pokynech k API příslušného produktu Cloudflare.

• categories Array<String>

  • Štítky přiřazené aktuálnímu pravidlu. Můžete definovat přepsání, která ovlivní pravidla s daným štítkem.
  • Pouze pro čtení. K dispozici pouze v WAF Managed Rules a Spravované sady pravidel DDoS.

• expression String

  • Kritéria určující, kdy dochází ke shodě s aktuálním pravidlem.
  • Pole a funkce, které můžete použít ve výrazu pravidla, závisí na fázi, ve které se sada pravidel daného pravidla spouští.

• last_updated Timestamp

  • Čas (UTC), kdy bylo pravidlo naposledy aktualizováno, ve formátu ISO 8601: YYYY-MM-DDThh:mm:ss.TZD.
  • Pouze pro čtení.

• enabled Boolean

  • Při nastavení na true, je aktuální pravidlo povoleno.