modify_outgoing_request_header
- Property Manager name: Modify Outgoing Request Header
- Behavior version: The
v2024-05-31
rule format supports themodify_outgoing_request_header
behavior v1.2. - Rule format status: GA, stable
- 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 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
.
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. | |||
standard_add_header_name | 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. | |||
standard_delete_header_name | 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. | |||
standard_modify_header_name | 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. | |||
custom_header_name | string (allows variables) | Specifies a custom field name that applies when the relevant standard header name is set to | 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_value | string (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_value | 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"}} |
regex_header_match | 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"}} |
regex_header_replace | string (allows variables) | Specifies text that replaces the | action is REGEX | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"action","op":"eq","value":"REGEX"}} |
match_multiple | boolean | When enabled with the | action is REGEX | {"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"action","op":"eq","value":"REGEX"}} |
avoid_duplicate_headers | boolean | When enabled with the | action is MODIFY | {"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"action","op":"eq","value":"MODIFY"}} |
Updated 4 days ago