Cloudflare Docs
Rules
Rules
Visit Rules on GitHub
Set theme to dark (⇧+D)

API parameter reference

Create different overrides by including different action parameters in the action_parameters field:

Override type What to include
Host header override host_header parameter
SNI override sni object
DNS record override / Destination port override origin object

​​ Host header override parameters

The full syntax of the action_parameters field for overriding the HTTP Host header is the following:


"action_parameters": {
"host_header": "<HOST_HEADER_VALUE>"
}

​​ SNI override parameters

The full syntax of the action_parameters field for overriding the SNI value of incoming requests is the following:


"action_parameters": {
"sni": {
"value": "<SNI_VALUE>"
}
}

​​ DNS record override and destination port override parameters

The full syntax of the action_parameters field for overriding both the hostname and the destination port of incoming requests is the following:


"action_parameters": {
"origin": {
"host": "<HOSTNAME>",
"port": <PORT>
}
}

If you are only overriding the hostname or the port, omit the port or host parameter, respectively.

​​ Configuring several overrides in the same rule

The same origin rule can have different types of overrides. For example, a single origin rule can perform an HTTP Host header override and a destination port override. The syntax of such a rule would be the following:


"action_parameters": {
"host_header": "<HOST_HEADER_VALUE>",
"origin": {
"port": <PORT>
}
}