Cloudflare Filters API の操作を呼び出すには、Cloudflare API のベース URL にエンドポイントを付けます。
https://api.cloudflare.com/client/v4/認証の手順は、Cloudflare API ドキュメントの はじめに: リクエスト を参照してください。
エンドポイントとページ分割については、はじめに: エンドポイント を参照してください。
Cloudflare Filters API は、次の操作に対応しています。各ページで例を確認できます。
| 操作 | メソッドとエンドポイント | 備考 |
|---|---|---|
| フィルターの作成 | POST zones/<ZONE_ID>/filters | 単一のトランザクションとして処理されます。エラーがあると、操作全体が失敗します。 |
| フィルターの取得 | GET zones/<ZONE_ID>/filters | 現在のフィルターをすべて一覧します。結果はデフォルトで 1 ページあたり 25 件です。任意のパラメーターで結果を絞り込めます。 |
| フィルターを 1 件取得 | GET zones/<ZONE_ID>/filters/<FILTER_ID> | ID を指定してフィルターを 1 件取得します。 |
| フィルターの更新 | PUT zones/<ZONE_ID>/filters | 単一のトランザクションとして処理されます。操作を成功させるには、すべてのフィルターが存在する必要があります。エラーがあると、操作全体が失敗します。 |
| フィルターを 1 件更新 | PUT zones/<ZONE_ID>/filters/<FILTER_ID> | ID を指定してフィルターを 1 件更新します。 |
| フィルターの削除 | DELETE zones/<ZONE_ID>/filters | 既存のフィルターを削除します。フィルター ID のリストを指定する必要があります。 空のリクエストでは何も削除されません。指定したフィルターが存在しない場合も、HTTP ステータスコード 200 を返します。 |
| フィルターを 1 件削除 | DELETE zones/<ZONE_ID>/filters/<FILTER_ID> | ID を指定してフィルターを削除します。 |