リストの JSON オブジェクト

リストオブジェクトの構造とプロパティ

Lists API の JSON 応答は、次の構造です。

{
	"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
	"name": "my_list_name",
	"description": "List description.",
	"kind": "(ip|hostname|asn|redirect)",
	"num_items": 10,
	"num_referencing_filters": 2,
	"created_on": "2021-01-01T08:00:00Z",
	"modified_on": "2021-01-10T14:00:00Z"
}

次の表は、オブジェクトのプロパティをまとめたものです。

プロパティ	説明	制約
`id` `String`	Cloudflare が生成する UUIDv4 識別子です。	一意、読み取り専用。長さ: 32 文字。
`name` `String`	リストのわかりやすい名前です。	最大長: 50 文字。使えるのは英数字とアンダースコア（`_`）だけです。有効な名前は、次の正規表現を満たします: `^[a-zA-Z0-9_]+$`。
`description` `String`	リストのわかりやすい概要です。	最大長: 500 文字。
`kind` `String`	リスト内のデータの種類です。	有効な値: `ip`、`hostname`、`asn`、`redirect`。
`num_items` `Number`	リスト内の項目数です。	読み取り専用。
`num_referencing_filters` `Number`	このリストを参照しているフィルターの数です。	読み取り専用。
`created_on` `String`	リストが作成された RFC 3339 タイムスタンプです。	読み取り専用。
`modified_on` `String`	リストが最後に変更された RFC 3339 タイムスタンプです。	読み取り専用。

リスト項目オブジェクトの構造とプロパティ

各リストの種類（IP アドレス、ホスト名、ASN、リダイレクト）には、同じ種類の項目しか含められません。

IP アドレス

IP アドレスリスト項目の、すべてのフィールドが入った JSON オブジェクトは次の構造です。

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"ip": "10.0.0.1/32",
	"comment": "CF DNS server",
	"created_on": "2021-10-01T05:20:00.12345Z",
	"modified_on": "2021-10-01T05:20:00.12345Z"
}

ホスト名

ホスト名リスト項目の、すべてのフィールドが入った JSON オブジェクトは次の構造です。

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"hostname": {
		"url_hostname": "*.example.com"
	},
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

ASN

ASN リスト項目の、すべてのフィールドが入った JSON オブジェクトは次の構造です。

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"asn": 13335,
	"comment": "My provider's ASN",
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

URL リダイレクト

Bulk Redirect List 項目の、すべてのフィールドが入った JSON オブジェクトは次の構造です。

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"redirect": {
		"source_url": "https://example.com/blog",
		"target_url": "https://example.com/blog/latest",
		"status_code": 301,
		"include_subdomains": false,
		"subpath_matching": false,
		"preserve_query_string": false,
		"preserve_path_suffix": true
	},
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

プロパティのリファレンス

リスト項目の JSON オブジェクトのプロパティは、次のとおりです。

プロパティ	説明	制約
`id` `String`	Cloudflare が生成する UUIDv4 識別子です。	一意、読み取り専用。長さ: 32 文字。
`ip` `String`	IP アドレスまたは CIDR 範囲です。	IP アドレスを持つカスタムリスト（IP リスト）にのみ適用されます。 IP アドレスを持つ同じカスタムリストに、次のいずれの形式も共存できます: IPv4 アドレス IPv6 アドレス `/8` から `/32` の CIDR としての IPv4 範囲 `/12` から `/128` の CIDR としての IPv6 範囲
`comment` `String`	項目のわかりやすい概要です。	最大長: 500 文字。
`redirect` `Object`	URL リダイレクトの定義を含むオブジェクトです。詳細は URL リダイレクトのパラメーターを参照してください。	Bulk Redirect Lists にのみ適用されます。
`hostname` `Object`	ホスト名の値を持つ `url_hostname` プロパティを含むオブジェクトです。サポートされるホスト名の値の詳細は、ホスト名を持つリストを参照してください。	ホスト名を持つカスタムリストにのみ適用されます。
`asn` `Integer`	ASN の値です。	ASN を持つカスタムリストにのみ適用されます。
`created_on` `String`	リストが作成された RFC 3339 タイムスタンプです。	読み取り専用。
`modified_on` `String`	項目が最後に変更された RFC 3339 タイムスタンプです。	読み取り専用。

詳細な仕様は、Lists API のドキュメントを参照してください。