API で Cloud Connector ルールを設定する

Cloudflare API で Cloud Connector ルールを設定できます。

必要な権限

Cloud Connector ルールを管理する API リクエストで使う API トークンには、少なくとも次の権限が必要です。

Zone > Cloud Connector > Write

エンドポイント

次の Cloudflare API ベース URL に、下表の Cloud Connector エンドポイントを付けて完全なエンドポイントにします。

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

{zone_id} 引数はゾーン ID（16 進文字列）です。この値は Cloudflare ダッシュボードで確認できます。

利用できる操作は次の表のとおりです。

操作	Verb + Endpoint
Cloud Connector ルールを一覧する	`GET /zones/{zone_id}/cloud_connector/rules`
Cloud Connector ルールを作成 / 更新 / 削除する	`PUT /zones/{zone_id}/cloud_connector/rules`

API 呼び出しの例

Cloud Connector ルールの一覧

次の例は、既存の Cloud Connector ルールの一覧を返します。

Required API token permissions

At least one of the following token permissions is required:

Cloud Connector Read
Cloud Connector Write

Rulesbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cloud_connector/rules" \
	--request GET \
	--header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
	--header "X-Auth-Key: $CLOUDFLARE_API_KEY"

{
	"result": [
		{
			"id": "<RULE_1_ID>",
			"provider": "aws_s3",
			"expression": "http.request.uri.path wildcard \"/images/*\"",
			"description": "Connect to S3 bucket containing images",
			"enabled": true,
			"parameters": {
				"host": "examplebucketwithimages.s3.north-eu.amazonaws.com"
			}
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

Cloud Connector ルールを作成 / 更新 / 削除する

次のリクエスト例は、既存の Cloud Connector ルールをすべて、1 件のルールに置き換えます。

Required API token permissions

At least one of the following token permissions is required:

Cloud Connector Write

Put Rulesbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/cloud_connector/rules" \
	--request PUT \
	--header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
	--header "X-Auth-Key: $CLOUDFLARE_API_KEY" \
	--json '[
		{
				"expression": "http.request.uri.path wildcard \"/images/*\"",
				"provider": "cloudflare_r2",
				"description": "Connect to R2 bucket containing images",
				"parameters": {
						"host": "mybucketcustomdomain.example.com"
				}
		}
	]'

各ルールで必須の本文パラメーターは expression、provider、parameters.host です。

provider の値は次のいずれかである必要があります。cloudflare_r2、aws_s3、azure_storage、gcp_storage、oci_storage。