エンドポイント

Lists API 操作を呼び出すには、エンドポイントを Cloudflare API ベース URL に追加します：

https://api.cloudflare.com/client/v4/

認証手順については、Cloudflare’s API: Getting Started を参照してください。

API 呼び出しや結果のページネーションに関するヘルプについては、Make API calls を参照してください。

Lists API は、以下に示す操作をサポートしています。関連リンクを訪れて例を確認してください。

リストの管理

操作	エンドポイント	メモ
Create a list	`POST accounts/{account_id}/rules/lists`	空のリストを作成します
Get lists	`GET accounts/{account_id}/rules/lists`	アカウントのすべてのリストを取得します。（このリクエストはリスト内のアイテムを取得しません。）
Get a list	`GET accounts/{account_id}/rules/lists/{list_id}`	ID によってリストを取得します。（このリクエストはリスト内のアイテムを表示しません。）
Update a list	`PUT accounts/{account_id}/rules/lists/{list_id}`	リストの `description` を更新します。`name` や `kind` を編集することはできず、リスト内のアイテムを更新することもできません。リスト内のアイテムを更新するには、Update all list items 操作を使用してください。
Delete a list	`DELETE accounts/{account_id}/rules/lists/{list_id}`	リストを削除しますが、フィルターがそれを参照していない場合のみ削除されます。

リスト内のアイテムを管理するためのほとんどの操作は非同期です。リストに大量のアイテムを追加または削除する場合、バルク操作が完了するまでに遅延が発生することがあります。

非同期リスト操作は operation_id を返し、これを使用して API 操作のステータスを監視できます。非同期操作のステータスを監視するには、Get bulk operation status エンドポイントを使用し、監視したい操作の ID を指定してください。

リストに対してリクエストを行う際に、そのリストでバルク操作が進行中の場合、リクエストはキューに入れられ、順番に処理されます（先入れ先出し）。成功した非同期操作のリクエストは HTTP 201 ステータスコードを返します。

操作: Get list items
メソッドとエンドポイント: GET accounts/{account_id}/rules/lists/{list_id}/items[?search={query}]
メモ:
- リスト内のアイテムを取得します（デフォルトではすべてのアイテム）。
- アイテムは昇順にソートされます。
- IP リストの場合、CIDR は IP アドレスでソートされ、その後サブネットマスクでソートされます。
- 返されるアイテムをフィルタリングするには、オプションの search クエリ文字列パラメータを使用してください。詳細については、Get list items API 操作を参照してください。

操作: Get a list item
メソッドとエンドポイント: GET accounts/{account_id}/rules/lists/{list_id}/items/{item_id}
メモ: ID によってリストからアイテムを取得します

操作: Create list items
メソッドとエンドポイント: POST accounts/{account_id}/rules/lists/{list_id}/items
メモ:
- リストに新しいアイテムまたはアイテムを追加します。
- リストに既に存在するエントリを置き換え、アイテムを削除することはありません。
- 元のアイテムの comment を上書きします。
- レスポンスには operation_id が含まれます。

操作: Update all list items
メソッドとエンドポイント: PUT accounts/{account_id}/rules/lists/{list_id}/items
メモ:
- リスト内のすべての現在のアイテムを削除し、items で置き換えます。
- items が空の場合、リスト内の すべての アイテムを削除します。
- レスポンスには operation_id が含まれます。