API

requestHeader

  • Property Manager name: Request Header
  • Criteria version: The v2025-10-16 rule format supports the requestHeader criteria v1.1.
  • Rule format status: GA, stable
  • Access: Read/Write
  • Allowed in includes: Yes

Match HTTP header names or values.

OptionTypeDescriptionRequires
header​Namestring

The name of the request header, for example Accept-Language.

{"displayType":"string","tag":"input","type":"text"}
match​Operatorenum 
Narrows the match criteria.
{"displayType":"enum","options":["IS_ONE_OF","IS_NOT_ONE_OF","EXISTS","DOES_NOT_EXIST"],"tag":"select"}
IS_​ONE_​OF
Tests whether the field's value string matches.
IS_​NOT_​ONE_​OF
Tests whether the field's value string does not match.
EXISTS
Tests if the header​Name field exists.
DOES_​NOT_​EXIST
Tests if the header​Name field is absent.
valuesstring array 
The request header's value, for example en-US when the header header​Name is Accept-Language.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
match​Wildcard​Nameboolean 
Allows wildcards in the header​Name field, where ? matches a single character and * matches zero or more characters.
{"displayType":"boolean","tag":"input","type":"checkbox"}
match​Wildcard​Valueboolean 
Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
match​Case​Sensitive​Valueboolean 
Sets a case-sensitive match for the value field.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}