modifyOutgoingRequestHeader


Modify, add, remove, or pass along specific request headers going upstream towards the origin.

Depending on the type of action you want to perform, specify the corresponding standard header name, or a custom‚ÄčHeader‚ÄčName if the standard name is set to OTHER. The header‚ÄčValue serves as a match condition when the action is DELETE or MODIFY, and the new‚ÄčHeader‚ÄčValue applies when the action is ADD or MODIFY. Whole-text replacements apply when the action is MODIFY, and substitutions apply when set to REGEX.

See also modify‚ÄčIncoming‚ÄčRequest‚ÄčHeader, modify‚ÄčIncoming‚ÄčResponse‚ÄčHeader, and modify‚ÄčOutgoing‚ÄčResponse‚ÄčHeader.

OptionTypeDescriptionRequires
actionenum

Either ADD or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.

{"displayType":"enum","options":["ADD","DELETE","MODIFY","REGEX"],"tag":"select"}
ADD

Add the header.

DELETE

Delete the header.

MODIFY

Modify the header.

REGEX

Specify another header to modify.

standard‚ÄčAdd‚ÄčHeader‚ÄčNameenum

If the value of action is ADD, this specifies the name of the field to add.

action is ADD
{"displayType":"enum","options":["USER_AGENT","OTHER"],"tag":"select"}
{"if":{"attribute":"action","op":"eq","value":"ADD"}}
USER_‚ÄčAGENT

The User-Agent header.

OTHER

Specify another header to add.

standard‚ÄčDelete‚ÄčHeader‚ÄčNameenum

If the value of action is DELETE, this specifies the name of the field to remove.

action is DELETE
{"displayType":"enum","options":["PRAGMA","USER_AGENT","VIA","OTHER"],"tag":"select"}
{"if":{"attribute":"action","op":"eq","value":"DELETE"}}
PRAGMA

The Pragma header.

USER_‚ÄčAGENT

The User-Agent header.

VIA

The Via header.

OTHER

Specify another header to remove.

standard‚ÄčModify‚ÄčHeader‚ÄčNameenum

If the value of action is MODIFY or REGEX, this specifies the name of the field to modify.

action is MODIFY
OR action is REGEX
{"displayType":"enum","options":["USER_AGENT","OTHER"],"tag":"select"}
{"if":{"op":"or","params":[{"attribute":"action","op":"eq","value":"MODIFY"},{"attribute":"action","op":"eq","value":"REGEX"}]}}
USER_‚ÄčAGENT

The User-Agent header.

OTHER

Specify another header to modify.

custom‚ÄčHeader‚ÄčNamestring (allows¬†variables)

Specifies a custom field name that applies when the relevant standard header name is set to OTHER.

standard‚ÄčAdd‚ÄčHeader‚ÄčName is OTHER
OR¬†standard‚ÄčDelete‚ÄčHeader‚ÄčName is OTHER
OR¬†standard‚ÄčModify‚ÄčHeader‚ÄčName is OTHER
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"or","params":[{"attribute":"standardAddHeaderName","op":"eq","value":"OTHER"},{"attribute":"standardDeleteHeaderName","op":"eq","value":"OTHER"},{"attribute":"standardModifyHeaderName","op":"eq","value":"OTHER"}]}}
header‚ÄčValuestring (allows¬†variables)

Specifies the new header value.

action is ADD
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"action","op":"eq","value":"ADD"}}
new‚ÄčHeader‚ÄčValuestring (allows¬†variables)

Specifies an HTTP header replacement value.

action is MODIFY
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"action","op":"eq","value":"MODIFY"}}
regex‚ÄčHeader‚ÄčMatchstring (allows¬†variables)

Specifies a Perl-compatible regular expression to match within the header value.

action is REGEX
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"action","op":"eq","value":"REGEX"}}
regex‚ÄčHeader‚ÄčReplacestring (allows¬†variables)

Specifies text that replaces the regex‚ÄčHeader‚ÄčMatch pattern within the header value.

action is REGEX
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"action","op":"eq","value":"REGEX"}}
match‚ÄčMultipleboolean

When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.

action is REGEX
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"action","op":"eq","value":"REGEX"}}
avoid‚ÄčDuplicate‚ÄčHeadersboolean

When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.

action is MODIFY
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"action","op":"eq","value":"MODIFY"}}