GuideReference
TrainingSupportCommunity
Reference

response_​header

  • Property Manager name: Response Header
  • Criteria version: The v2024-01-09 rule format supports the response_​header criteria v1.2.
  • 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 response header, for example Content-Type.

{"displayType":"string","tag":"input","type":"text"}
match_​operatorenum

Narrows the match according to various criteria.

{"displayType":"enum","options":["IS_ONE_OF","IS_NOT_ONE_OF","EXISTS","DOES_NOT_EXIST","IS_LESS_THAN","IS_MORE_THAN","IS_BETWEEN"],"tag":"select"}
IS_​ONE_​OF

The field's value string matches.

IS_​NOT_​ONE_​OF

The field's value string does not match.

EXISTS

The HTTP field header_​name is present.

DOES_​NOT_​EXIST

The HTTP field header_​name is absent.

IS_​LESS_​THAN

Matches ranges when the value is numeric.

IS_​MORE_​THAN

Matches ranges when the value is numeric.

IS_​BETWEEN

Is between the numeric lower_​bound and upper_​bound values.

valuesstring array

The response header's value, for example application/x-www-form-urlencoded when the header header_​name is Content-Type.

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"]}}
lower_​boundnumber

When the value is numeric, this field specifies the match's minimum value.

match_​operator is either: IS_​MORE_​THAN, IS_​BETWEEN
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_MORE_THAN","IS_BETWEEN"]}}
upper_​boundnumber

When the value is numeric, this field specifies the match's maximum value.

match_​operator is either: IS_​LESS_​THAN, IS_​BETWEEN
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_LESS_THAN","IS_BETWEEN"]}}
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

When enabled, the match is case-sensitive 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"]}}