modify outgoing request

Version: `v2024-08-13`	Includes use: Yes

Behavior name: Modify Outgoing Request Header

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

Related behaviors:

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "modify_outgoing_request_header" {
  rules_v2025_02_18 {
    name     = "Modify Outgoing Request Header"
    comments = "Modifies, adds, removes, or passes along specific request headers going upstream towards the origin."
    behavior {
      modify_outgoing_request_header {
        action                   = "ADD"
        standard_add_header_name = "USER_AGENT"
        header_value             = ""
      }
    }
  }
}

"behaviors": [
  {
    "name": "modifyOutgoingRequestHeader",
    "options": {
      "action": "ADD",
      "standardAddHeadername": "USER_AGENT",
      "headerValue": ""
    }
  }
]

Options

Option	Description
`action`	Enum The action to take on incoming HTTP request headers. Value is one of: `ADD`. Add the header. `DELETE`. Delete the header. `MODIFY`. Modify the header. `REGEX`. Pass through the header.
`standard_add_header_name`	Enum \| Requires: `action` is `ADD` Specifies the name of the field to add. Value is one of: `USER_AGENT`. The `USER_AGENT` header. `OTHER`. Specify another header to add.
`standard_delete_header_name`	Enum \| Requires: `action` is `DELETE` Specifies the name of the field to remove. Value is one of: `PRAGMA`. The `PRAGMA` header. `USER_AGENT`. The `USER_AGENT` header. `VIA`. The `VIA` header. `OTHER`. Specify another header to remove.
`standard_modify_header_name`	Enum \| Requires Requires `action` is one of: `MODIFY` `REGEX` Specifies the name of the field to modify. Value is one of: `USER_AGENT`. The `USER_AGENT` header. `OTHER`. Specify another header to modify.
`custom_header_name`	String \| Requires Requires one of these is set to `OTHER`: `standard_add_header_name` `standard_delete_header_name` `standard_modify_header_name` Specifies a custom field name.
`header_value`	Enum \| Requires: `action` is `ADD` Specifies the new header value.
`new_header_value`	Enum \| Requires: `action` is `MODIFY` Supplies an HTTP header replacement value
`avoid_duplicate_headers`	Boolean \| Requires: `action` is `REGEX` Prevents creation of more than one instance of a header.
`regex_header_match`	String \| Requires: `action` is `REGEX` Specifies a Perl-compatible regular expression to match within the header value.
`regex_header_replace`	String \| Requires: `action` is `REGEX` Specifies text that replaces the `regex_header_match` pattern within the header value.
`match_multiple`	Boolean \| Requires: `action` is `MODIFY` When enabled with the `action` set to `REGEX` replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.