API でゾーンバージョンのキャッシュをパージする

Cloudflare API でゾーンバージョンのキャッシュをパージするには、次の手順に従います。

手順 1: 環境 ID を取得する

まず、次の API エンドポイントにリクエストを送り、ゾーンの環境 ID を取得します。

https://api.cloudflare.com/client/v4/zones/<zone_id>/environments

この API 呼び出しは、次のような JSON レスポンスを返します。

{
  "result": {
    "environments": [
      {
        "name": "Production",
        "ref": "12abcd3e45f678940a573f51834a54",
        "version": 0,
        "expression": "(cf.zone.name eq \"example.com\")",
        "locked_on_deployment": false,
        "position": {
          "before": "5d41402abc4b2a76b9719d911017c"
        }
      },
      {
        "name": "Staging",
        "ref": "5d41402abc4b2a76b9719d911017c",
        "version": 0,
        "expression": "((cf.edge.server_ip in {1.2.3.4 5.6.7.8})) and (cf.zone.name eq \"example.com\")",
        "locked_on_deployment": false,
        "position": {
          "before": "49f0bad299687c62334182178bfd",
          "after": "12abcd3e45f678940a573f51834a54"
        }
      },
      {
        "name": "Development",
        "ref": "49f0bad299687c62334182178bfd",
        "version": 0,
        "expression": "((any(http.request.cookies[\"development\"][*] eq \"true\"))) and (cf.zone.name eq \"example.com\")",
        "locked_on_deployment": false,
        "position": {
          "after": "5d41402abc4b2a76b9719d911017c"
        }
      }
    ]
  },
  "success": true,
  "errors": [],
  "messages": []
}

この例では、Production、Staging、Development の 3 つの環境があります。環境 ID は ref フィールドにあります。

手順 2: 環境ごとにキャッシュをパージする

Production 環境をパージするには、通常のキャッシュパージエンドポイントを使います。

https://api.cloudflare.com/client/v4/zones/<zone_id>/purge_cache/

本番以外の環境をパージする場合は、新しい purge_cache エンドポイントを使い、パージする環境を指定します。

上記の例の Staging 環境をパージするには、次のエンドポイントにリクエストを送ります。

https://api.cloudflare.com/client/v4/zones/<zone_id>/environments/5d41402abc4b2a76b9719d911017c/purge_cache/

上記の例の Development 環境をパージするには、次のエンドポイントにリクエストを送ります。

https://api.cloudflare.com/client/v4/zones/<zone_id>/environments/49f0bad299687c62334182178bfd/purge_cache/