エンドポイント
一部の操作では、フェーズエントリポイントルールセットを管理するために、Rulesets APIが提供する特定のエンドポイントを使用できます。これらのエンドポイントでは、ルールセットIDの代わりにフェーズ名がエンドポイントに含まれます。
例えば、次のエンドポイントを使用する代わりに:
PUT /zones/{zone_id}/rulesets/{ruleset_id}次のエンドポイントを使用できます:
PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypointRulesets API操作を呼び出すには、エンドポイントをCloudflare APIのベースURLに追加します:
https://api.cloudflare.com/client/v4認証手順については、Cloudflare APIドキュメントのGetting Started: Requestsを参照してください。
エンドポイントとページネーションに関するヘルプについては、Getting Started: Endpointsを参照してください。
Rulesets APIエンドポイントでは、{account_id}または{zone_id}の値が必要です。
アクセス可能なアカウントのリストを取得するには、List Accounts操作を使用します。管理したいアカウントのIDをメモしてください。
アクセス可能なゾーンのリストを取得するには、List Zones操作を使用します。管理したいゾーンのIDをメモしてください。
Cloudflare Rulesets APIは、以下に示す操作をサポートしています。APIエンドポイントと例については、関連リンクを訪問してください。
| 操作 | メソッド | ノート |
|---|---|---|
| 既存のルールセットをリスト | GET | アカウントレベルまたはゾーンレベルでの既存のルールセットのリストを返します。 |
| 特定のルールセットを表示 | GET | 特定のルールセットの最新バージョンのプロパティを返します。 |
ルールセットのすべてのバージョンをリスト | GET | ルールセットのすべてのバージョンのリストを返します。 |
特定のルールセットのバージョンを表示 | GET | 特定のルールセットのバージョンの構成を返します。ルールを含みます。 |
特定のタグを持つ管理されたルールセットのルールをリスト | GET | 特定のタグを持つ管理されたルールセットのすべてのルールのリストを返します。 |
| 操作 | 動詞 | ノート |
|---|---|---|
| ルールセットを作成 | POST | 新しいルールセットまたは新しいフェーズエントリポイントを作成します。 |
| 操作 | 動詞 | ノート |
|---|---|---|
| ルールセットを更新またはデプロイ | PUT | ルールセットの基本プロパティとルールセット内のルールのリストを更新します。 管理されたルールセットの実行を構成できます。 |
| ルールセットにルールを追加 | POST | 既存のルールセットに単一のルールを追加します。 すべての既存のルールセットルールをリクエストに含めることなく、単一のルールを追加できます。 |
| ルールセット内のルールを更新 | PATCH | ルールセット内の単一のルールの定義を更新します。 ルールセット内のルールの順序を変更できます。 |
| ルールセット内のルールを削除 | DELETE | ルールセット内の単一のルールを削除します。 |
| 操作 | 動詞 | ノート |
|---|---|---|
| ルールセットを削除 | DELETE | ルールセットのすべてのバージョンを削除します。 |
| ルールセットバージョンを削除 | DELETE | 特定のルールセットのバージョンを削除します。 |