コンテンツにスキップ

エンドポイント

一部の操作では、フェーズエントリポイントルールセットを管理するために、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を参照してください。

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

特定のルールセットのバージョンを削除します。