エンドポイント

一部の操作では、フェーズのエントリポイントルールセットを管理する Rulesets API の専用エンドポイントを使えます。これらのエンドポイントは、ルールセット ID の代わりにフェーズ名をパスに含めます。

たとえば、次のエンドポイントの代わりに:

PUT /zones/{zone_id}/rulesets/{ruleset_id}

次のエンドポイントを使えます。

PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint

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

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

認証の手順は、Cloudflare API ドキュメントの Getting Started: Requests を参照してください。

エンドポイントとページネーションの説明は、Getting Started: Endpoints を参照してください。

Cloudflare Rulesets API は、次の操作をサポートします。API エンドポイントと例は、各リンクを参照してください。

ルールセットの一覧と表示

操作	メソッド	備考
既存のルールセットを一覧する	`GET`	アカウントレベルまたはゾーンレベルにある既存ルールセットの一覧を返します。
特定のルールセットを表示する	`GET`	特定のルールセットの最新バージョンのプロパティを返します。
ルールセットの全バージョンを一覧する	`GET`	ルールセットの全バージョンの一覧を返します。
ルールセットの特定バージョンを表示する	`GET`	ルールを含む、ルールセットの特定バージョンの設定を返します。
特定タグのマネージドルールセット内ルールを一覧する	`GET`	特定のタグが付いたマネージドルールセット内の全ルールの一覧を返します。

操作	メソッド	備考
ルールセットを作成する	`POST`	新しいルールセット、または新しいフェーズエントリポイントを作成します。

操作	メソッド	備考
ルールセットを更新またはデプロイする	`PUT`	ルールセットの基本プロパティと、含まれるルールの一覧を更新します。マネージドルールセットの実行を設定できます。
ルールセットにルールを追加する	`POST`	既存のルールセットにルールを 1 件追加します。既存の全ルールをリクエストに含めなくても、1 件だけ追加できます。
ルールセット内のルールを更新する	`PATCH`	ルールセット内の 1 件のルール定義を更新します。ルールセット内のルールの順序も変更できます。
ルールセット内のルールを削除する	`DELETE`	ルールセット内のルールを 1 件削除します。

操作	メソッド	備考
ルールセットを削除する	`DELETE`	ルールセットの全バージョンを削除します。
ルールセットのバージョンを削除する	`DELETE`	ルールセットの特定バージョンを削除します。