API でオリジンルールを作成する

Rulesets API を使って、API からオリジンルールを作成します。

基本的なルール設定

API でオリジンルールを作成するときは、次を確認してください。

ルールアクションを route に設定する。
オリジン上書きの種類に応じて、action_parameters フィールドにパラメーターを定義する。
ゾーンレベルで、ルールを http_request_origin フェーズにデプロイする。

手順

API を使って、指定したゾーンに an origin rule を作成するには、次のワークフローに従います。

ゾーンルールセットを一覧する操作を使い、ゾーンレベルで http_request_origin フェーズのルールセットがすでにあるかを確認します。
フェーズのルールセットが存在しない場合は、ゾーンルールセットを作成する操作で作成します。新しいルールセットのプロパティには、次の値を設定します。
- kind: zone
- phase: http_request_origin
ゾーンルールセットを更新する操作を使い、ルールセットのルール一覧に an origin rule を追加します。または、前のステップで説明したゾーンルールセットを作成するリクエストにルールを含めます。

API トークンに、API 操作を実行するための必要な権限があることを確認してください。

リクエストの例

例: 受信リクエストの Host ヘッダーと解決済み DNS レコードを上書きするルールを追加する

次の例では、ゾーンルールセットを更新する操作を使い、既存のフェーズルールセット（$RULESET_ID）のルールをオリジンルール 1 件に設定します。このルールは、受信リクエストの Host ヘッダーと解決先の DNS レコードを上書きします。レスポンスには、更新したルールセットの完全な定義が含まれます。

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 '{
		"rules": [
				{
						"ref": "hr_app_overrides",
						"expression": "starts_with(http.request.uri.path, \"/hr-app/\")",
						"description": "Origin rule for the company HR application",
						"action": "route",
						"action_parameters": {
								"host_header": "hr-server.example.com",
								"origin": {
										"host": "hr-server.example.com"
								}
						}
				}
		]
	}'

{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Origin Rules ruleset",
		"description": "Zone-level ruleset that will execute origin rules.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"ref": "hr_app_overrides",
				"id": "<RULE_ID>",
				"version": "1",
				"action": "route",
				"action_parameters": {
					"host_header": "hr-server.example.com",
					"origin": {
						"host": "hr-server.example.com"
					}
				},
				"expression": "starts_with(http.request.uri.path, \"/hr-app/\")",
				"description": "Origin rule for the company HR application",
				"last_updated": "2022-06-03T14:42:04.219025Z",
				"ref": "<RULE_REF>"
			}
		],
		"last_updated": "2022-06-03T14:42:04.219025Z",
		"phase": "http_request_origin"
	},
	"success": true,
	"errors": [],
	"messages": []
}

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

例: 受信リクエストのポートを上書きするルールを追加する

次の例は、ゾーンルールセットを更新する操作を使い、既存のフェーズルールセット（$RULESET_ID）のルールを、受信リクエストのポートを上書きするオリジンルール 1 件に設定します。レスポンスには、更新したルールセットの完全な定義が含まれます。

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 '{
		"rules": [
				{
						"ref": "calendar_app_change_port",
						"expression": "starts_with(http.request.uri.path, \"/team/calendar/\")",
						"description": "Origin rule for the team calendar application",
						"action": "route",
						"action_parameters": {
								"origin": {
										"port": 8081
								}
						}
				}
		]
	}'

{
	"result": {
		"id": "<RULESET_ID>",
		"name": "Origin Rules ruleset",
		"description": "Zone-level ruleset that will execute origin rules.",
		"kind": "zone",
		"version": "2",
		"rules": [
			{
				"ref": "calendar_app_change_port",
				"id": "<RULE_ID>",
				"version": "1",
				"action": "route",
				"action_parameters": {
					"origin": {
						"port": 8081
					}
				},
				"expression": "starts_with(http.request.uri.path, \"/team/calendar/\")",
				"description": "Origin rule for the team calendar application",
				"last_updated": "2022-06-03T14:42:04.219025Z",
				"ref": "<RULE_REF>"
			}
		],
		"last_updated": "2022-06-03T14:42:04.219025Z",
		"phase": "http_request_origin"
	},
	"success": true,
	"errors": [],
	"messages": []
}

例: 受信リクエストの SNI 値を上書きするルールを追加する

次の例では、Update a zone ruleset 操作を使い、既存のフェーズルールセット（$RULESET_ID）のルールを、1 件のオリジンルールに設定します。このルールは、admin.example.com 宛ての受信リクエストの SNI 値を上書きします。

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 '{
		"rules": [
				{
						"ref": "override_sni_for_admin",
						"expression": "http.host eq \"admin.example.com\"",
						"description": "SNI Override for the admin area",
						"action": "route",
						"action_parameters": {
								"sni": {
										"value": "sni.example.com"
								}
						}
				}
		]
	}'

必要な API トークン権限

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

Zone > Origin Rules > Edit