- Property Manager name: Modify Outgoing Request Header
- Behavior version: The
v2024-08-13
rule format supports themodifyOutgoingRequestHeader
behavior v1.2. - Rule format status: Deprecated, outdated rule format
- Access: Read/Write
- Allowed in includes: Yes
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 customHeaderName
if the standard name is set to OTHER
. The headerValue
serves as a match condition when the action is DELETE
or MODIFY
, and the newHeaderValue
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 modifyIncomingRequestHeader
, modifyIncomingResponseHeader
, and modifyOutgoingResponseHeader
.
Option | Type | Description | Requires | |
---|---|---|---|---|
action | enum | Either | {"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. | |||
standardAddHeaderName | enum | If the value of | action is ADD | {"displayType":"enum","options":["USER_AGENT","OTHER"],"tag":"select"} {"if":{"attribute":"action","op":"eq","value":"ADD"}} |
USER_AGENT | The | |||
OTHER | Specify another header to add. | |||
standardDeleteHeaderName | enum | If the value of | action is DELETE | {"displayType":"enum","options":["PRAGMA","USER_AGENT","VIA","OTHER"],"tag":"select"} {"if":{"attribute":"action","op":"eq","value":"DELETE"}} |
PRAGMA | The | |||
USER_AGENT | The | |||
VIA | The | |||
OTHER | Specify another header to remove. | |||
standardModifyHeaderName | enum | If the value of | 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 | |||
OTHER | Specify another header to modify. | |||
customHeaderName | string (allows variables) | Specifies a custom field name that applies when the relevant standard header name is set to | standardAddHeaderName is OTHER OR standardDeleteHeaderName is OTHER OR standardModifyHeaderName 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"}]}} |
headerValue | string (allows variables) | Specifies the new header value. | action is ADD | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"action","op":"eq","value":"ADD"}} |
newHeaderValue | string (allows variables) | Specifies an HTTP header replacement value. | action is MODIFY | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"action","op":"eq","value":"MODIFY"}} |
regexHeaderMatch | string (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"}} |
regexHeaderReplace | string (allows variables) | Specifies text that replaces the | action is REGEX | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"action","op":"eq","value":"REGEX"}} |
matchMultiple | boolean | When enabled with the | action is REGEX | {"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"action","op":"eq","value":"REGEX"}} |
avoidDuplicateHeaders | boolean | When enabled with the | action is MODIFY | {"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"action","op":"eq","value":"MODIFY"}} |