Lists API のエンドポイント

Lists API の操作を呼び出すには、Cloudflare API のベース URL にエンドポイントを付けます。

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

認証の手順は、Cloudflare API の はじめに を参照してください。

API の呼び出し方法と結果のページネーションは、API 呼び出しを行う を参照してください。

Lists API は、次の操作に対応しています。各リンク先に使用例があります。

• 操作: リストを作成する
• メソッドとエンドポイント: POST accounts/{account_id}/rules/lists
• 備考: 空のリストを作成します。

• 操作: リストを取得する
• メソッドとエンドポイント: GET accounts/{account_id}/rules/lists
• 備考:
  • アカウントのすべてのリストを取得します。
  • このリクエストでは、リスト内の項目は取得しません。

• 操作: 1 件のリストを取得する
• メソッドとエンドポイント: GET accounts/{account_id}/rules/lists/{list_id}
• 備考:
  • ID を指定してリストを取得します。
  • このリクエストでは、リスト内の項目は表示しません。

• 操作: リストを更新する
• メソッドとエンドポイント: PUT accounts/{account_id}/rules/lists/{list_id}
• 備考:
  • リストの description を更新します。
  • name と kind は編集できません。リスト内の項目も、この操作では更新できません。項目を更新するには、すべてのリスト項目を更新する 操作を使います。

• 操作: リストを削除する
• メソッドとエンドポイント: DELETE accounts/{account_id}/rules/lists/{list_id}
• 備考: リストを削除します。フィルター から参照されていない場合に限ります。

リスト内の項目を管理する操作のほとんどは非同期です。多数の項目をリストに追加したり、リストから削除したりすると、一括操作が完了するまでに遅延することがあります。

非同期のリスト操作は operation_id を返します。この ID で API 操作の状態を監視できます。非同期操作の状態を監視するには、一括操作の状態を取得する エンドポイントを使い、監視したい操作の ID を指定します。

一括操作の進行中に同じリストへリクエストを送ると、リクエストはキューに入り、到着順（先入れ先出し）で処理されます。成功した非同期操作のリクエストは、HTTP 201 ステータスコードを返します。

• 操作: リスト項目を取得する
• メソッドとエンドポイント: GET accounts/{account_id}/rules/lists/{list_id}/items[?search={query}]
• 備考:
  • リスト内の項目を取得します（デフォルトは全項目）。
  • 項目は昇順で並びます。
  • IP リストの場合、CIDR は IP アドレス、続いてサブネットマスクで並びます。
  • 返す項目を絞り込むには、任意の search クエリ文字列パラメーターを使います。詳細は リスト項目を取得する API 操作を参照してください。

• 操作: 1 件のリスト項目を取得する
• メソッドとエンドポイント: GET accounts/{account_id}/rules/lists/{list_id}/items/{item_id}
• 備考: ID を指定して、リストから項目を取得します

• 操作: リスト項目を作成する
• メソッドとエンドポイント: POST accounts/{account_id}/rules/lists/{list_id}/items
• 備考:
  • 新しい項目をリストに追加します。
  • すでに存在するエントリは置き換えます。項目は削除しません。
  • 元の項目の comment を上書きします。
  • 応答には operation_id が含まれます。

• 操作: すべてのリスト項目を更新する
• メソッドとエンドポイント: PUT accounts/{account_id}/rules/lists/{list_id}/items
• 備考:
  • リスト内の現在の項目をすべて削除し、items で置き換えます。
  • items が空の場合、リスト内の項目を すべて 削除します。
  • 応答には operation_id が含まれます。

• 操作: リスト項目を削除する
• メソッドとエンドポイント: DELETE accounts/{account_id}/rules/lists/{list_id}/items
• 備考:
  • 指定したリスト項目を削除します。
  • 応答には operation_id が含まれます。