JSON オブジェクト

このページでは、Rulesets API でルールセットとそのルールを作成または更新する API リクエストで使う JSON オブジェクトと、API が返すオブジェクトを説明します。

ルールセットオブジェクト

完全に埋まっているルールセットオブジェクトの 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 配列内のルール項目のプロパティは、ルールオブジェクトの構造とプロパティを参照してください。

プロパティ

ルールセットオブジェクトには、次のプロパティがあります。

id String
- ルールセットのあるバージョンを表す、Cloudflare が生成した一意の識別子です。32 文字の UUIDv4 文字列です。
- 一意で、読み取り専用です。
name String
- ルールセットの分かりやすい名前です。
- 名前は不変です。ルールセットの存続期間中は変更できません。
description String
- ルールセットの任意の説明です。
- ルールセットの存続期間中に変更できます。
kind String
- JSON オブジェクトが表すルールセットの種類です。
- root、zone、managed、custom のいずれかです。
- kind は不変です。
version Integer
- ルールセットのバージョンです。
- 読み取り専用で、1 から始まり、ルールセットを変更するたびに 1 ずつ増えます。
rules Array<Rule>
- ルールセットに含めるルールの一覧です。詳細はルールオブジェクトの構造とプロパティを参照してください。
last_updated Timestamp
- ルールセットを最後に更新した時刻（UTC）です。ISO 8601 形式: YYYY-MM-DDThh:mm:ss.TZD。
- 読み取り専用です。

ルールオブジェクトの構造とプロパティ

完全に埋まっているルールの 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 オブジェクトプロパティは、次のとおりです。

id String
- ルールのあるバージョンを表す、Cloudflare が生成した一意の識別子です。32 文字の UUIDv4 文字列です。
- 一意で、読み取り専用です。
version Integer
- ルールのバージョンです。
- 読み取り専用で、1 から始まり、ルールを変更するたびに 1 ずつ増えます。
- ルールセット内のルールの順序を変えても、バージョンは変わりません。
ref String
- ユーザーが定義する外部識別子です。ルールセット内の各ルールで一意である必要があります。
- Terraform 設定でこのフィールドを使うと、変更時に Terraform がルールを作り直すのを防げます。詳細は変更後も同じルール ID を保つ方法を参照してください。
description String
- ルールの説明的な名前です。
action String
- ルール式に一致したときに何が起きるかを定義します。
- 利用できるアクションは、ルールのルールセットが実行されるフェーズによります。
action_parameters Object
- ルールアクションを設定する 1 つ以上のパラメーターです。
- 正確なプロパティはアクションによります。詳細は、各 Cloudflare 製品の API 手順を参照してください。
categories Array<String>
- 現在のルールに関連するタグです。特定のタグを持つルールに影響するオーバーライドを定義できます。
- 読み取り専用です。WAF Managed Rules と DDoS マネージドルールセットでのみ使えます。
expression String
- 現在のルールに一致する条件です。
- ルール式で使えるフィールドと関数は、ルールのルールセットが実行されるフェーズによります。
last_updated Timestamp
- ルールを最後に更新した時刻（UTC）です。ISO 8601 形式: YYYY-MM-DDThh:mm:ss.TZD。
- 読み取り専用です。
enabled Boolean
- true のとき、現在のルールは有効です。