API でリダイレクトルールを作成する

Rulesets API を使って、API からリダイレクトルールを作成します。

ゾーンレベルの http_request_dynamic_redirect フェーズのエントリポイントルールセットに、リダイレクトルールを追加します。ルールセットの作成と、ルールセットへ渡すルール一覧の詳細は、Rulesets API のドキュメントを参照してください。

基本的なルール設定

リダイレクトルールには次が必要です。

action を redirect に設定する
追加の設定を入れた action_parameters オブジェクト — 詳細は Single Redirects の設定を参照してください。

リクエストの例

次の Create a zone ruleset 操作のリクエストは、ゾーンレベルで http_request_dynamic_redirect フェーズのフェーズエントリポイントルールセットを作成し、動的 URL リダイレクトのリダイレクトルールを 1 件定義します。http_request_dynamic_redirect フェーズのフェーズエントリポイントルールセットをまだ作っていない場合に、この操作を使います。

Required API token permissions

At least one of the following token permissions is required:

Response Compression Write
Config Settings Write
Dynamic URL Redirects Write
Cache Settings Write
Custom Errors Write
Origin Write
Managed headers Write
Zone Transform Rules Write
Mass URL Redirects Write
Magic Firewall Write
L4 DDoS Managed Ruleset Write
HTTP DDoS Managed Ruleset Write
Sanitize Write
Transform Rules Write
Select Configuration Write
Bot Management Write
Zone WAF Write
Account WAF Write
Account Rulesets Write
Logs Write
Logs Write

Create a zone rulesetbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "Redirect rules ruleset",
		"kind": "zone",
		"phase": "http_request_dynamic_redirect",
		"rules": [
				{
						"ref": "redirect_gb_fr_to_localized",
						"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
						"description": "Redirect GB and FR users in home page to localized site.",
						"action": "redirect",
						"action_parameters": {
								"from_value": {
										"target_url": {
												"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
										},
										"status_code": 307,
										"preserve_query_string": true
								}
						}
				}
		]
	}'

レスポンス

{
	"result": {
		"id": "528f4f03bf0da53a29907199625867be",
		"name": "Redirect rules ruleset",
		"kind": "zone",
		"version": "1",
		"rules": [
			{
				"ref": "redirect_gb_fr_to_localized",
				"id": "235e557b92fd4e5e8753ee665a9ddd75",
				"version": "1",
				"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
				"description": "Redirect GB and FR users in home page to localized site.",
				"action": "redirect",
				"action_parameters": {
					"from_value": {
						"target_url": {
							"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
						},
						"status_code": 307,
						"preserve_query_string": true
					}
				},
				"last_updated": "2022-09-28T09:20:42Z"
			}
		],
		"last_updated": "2022-09-28T09:20:42Z",
		"phase": "http_request_dynamic_redirect"
	},
	"success": true,
	"errors": [],
	"messages": []
}

Terraform を使う場合、更新をまたいでルール ID を安定させるには ref フィールドを使います。このフィールドを追加すると、変更時に Terraform がルールを再作成するのを防げます。詳細は Terraform ドキュメントのトラブルシューティングを参照してください。

http_request_dynamic_redirect フェーズのフェーズエントリポイントルールセットがすでにある場合は、代わりに Update a zone ruleset 操作を使います。次の例のとおりです。

Required API token permissions

At least one of the following token permissions is required:

Response Compression Write
Config Settings Write
Dynamic URL Redirects Write
Cache Settings Write
Custom Errors Write
Origin Write
Managed headers Write
Zone Transform Rules Write
Mass URL Redirects Write
Magic Firewall Write
L4 DDoS Managed Ruleset Write
HTTP DDoS Managed Ruleset Write
Sanitize Write
Transform Rules Write
Select Configuration Write
Bot Management Write
Zone WAF Write
Account WAF Write
Account Rulesets Write
Logs Write
Logs Write

Update a zone rulesetbash

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "Redirect rules ruleset",
		"kind": "zone",
		"phase": "http_request_dynamic_redirect",
		"rules": [
				{
						"ref": "redirect_gb_fr_to_localized",
						"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
						"description": "Redirect GB and FR users in home page to localized site.",
						"action": "redirect",
						"action_parameters": {
								"from_value": {
										"target_url": {
												"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
										},
										"status_code": 307,
										"preserve_query_string": true
								}
						}
				},
				{
						"ref": "redirect_contacts_to_new_page",
						"expression": "http.request.uri.path eq \"/contacts.html\"",
						"description": "Redirect to new contacts page.",
						"action": "redirect",
						"action_parameters": {
								"from_value": {
										"target_url": {
												"value": "https://example.com/contact-us/"
										},
										"status_code": 308
								}
						}
				}
		]
	}'

レスポンス

{
	"result": {
		"id": "528f4f03bf0da53a29907199625867be",
		"name": "Redirect rules ruleset",
		"description": "",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"ref": "redirect_gb_fr_to_localized",
				"id": "235e557b92fd4e5e8753ee665a9ddd75",
				"version": "1",
				"action": "redirect",
				"action_parameters": {
					"from_value": {
						"target_url": {
							"expression": "lower(concat(\"https://\", ip.src.country, \".example.com\"))"
						},
						"status_code": 307,
						"preserve_query_string": true
					}
				},
				"expression": "(ip.src.country eq \"GB\" or ip.src.country eq \"FR\") and http.request.uri.path eq \"/\"",
				"description": "Redirect GB and FR users in home page to localized site.",
				"last_updated": "2022-10-03T15:38:51.658387Z",
				"ref": "235e557b92fd4e5e8753ee665a9ddd75",
				"enabled": true
			},
			{
				"ref": "redirect_contacts_to_new_page",
				"id": "cfad5efbfcd1440fb5b30cf30f95ece3",
				"version": "1",
				"action": "redirect",
				"action_parameters": {
					"from_value": {
						"target_url": {
							"value": "https://example.com/contact-us/"
						},
						"status_code": 308
					}
				},
				"expression": "http.request.uri.path eq \"/contacts.html\"",
				"description": "Redirect to new contacts page.",
				"last_updated": "2022-10-03T15:38:51.658387Z",
				"ref": "cfad5efbfcd1440fb5b30cf30f95ece3",
				"enabled": true
			}
		],
		"last_updated": "2022-10-03T15:38:51.658387Z",
		"phase": "http_request_dynamic_redirect"
	},
	"success": true,
	"errors": [],
	"messages": []
}

必要な API トークン権限

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

Zone > Single Redirect > Edit