HTTPRequestRule
HTTPRequestRule
JSON Example
{
"all_headers": false,
"enable": false,
"hdr_action": [
{
"action": "string",
"cookie": {
"name": "string",
"value": "string"
},
"hdr": {
"name": "string",
"value": {
"is_sensitive": false,
"val": "string",
"var": "string"
}
},
"hdr_index": 0
}
],
"index": 0,
"log": false,
"match": {
"bot_detection_result": {
"classifications": [
{
"type": "string",
"user_defined_type": "string"
}
],
"match_operation": "string"
},
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"cookie": {
"match_case": "string",
"match_criteria": "string",
"name": "string",
"value": "string"
},
"geo_matches": [
{
"attribute": "string",
"match_operation": "string",
"values": [
"string"
]
}
],
"hdrs": [
{
"hdr": "string",
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
}
],
"host_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"ip_reputation_type": {
"match_operation": "string",
"reputation_types": [
"string"
]
},
"method": {
"match_criteria": "string",
"methods": [
"string"
]
},
"path": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"protocol": {
"match_criteria": "string",
"protocols": "string"
},
"query": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"source_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"tls_fingerprint_match": {
"fingerprints": [
"string"
],
"match_operation": "string",
"string_group_refs": [
"string"
]
},
"version": {
"match_criteria": "string",
"versions": [
"string"
]
},
"vs_port": {
"match_criteria": "string",
"ports": [
0
]
}
},
"name": "string",
"redirect_action": {
"add_string": "string",
"host": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"keep_query": false,
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"port": 0,
"protocol": "string",
"status_code": "string"
},
"rewrite_url_action": {
"host_hdr": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"query": {
"add_string": "string",
"keep_query": false
}
},
"switching_action": {
"action": "string",
"file": {
"content_type": "string",
"file_content": "string",
"file_length": 0
},
"other_status_code": 0,
"pool_group_ref": "string",
"pool_ref": "string",
"server": {
"hostname": "string",
"ip": {
"addr": "string",
"type": "string"
},
"port": 0
},
"status_code": "string"
}
}boolean
all_headers
Optional
Log all HTTP headers upon rule match. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
boolean
enable
Required
Constraints: default: true
Enable or disable the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
array of HTTPHdrAction
hdr_action
Optional
HTTP header rewrite action. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
integer As int32 As int32
index
Required
Index of the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
boolean
log
Optional
Log HTTP request upon rule match. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
string
name
Required
Name of the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.