BotAllowRule

BotAllowRule
BotAllowRule
JSON Example
{
    "action": "string",
    "condition": {
        "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",
                "string_group_refs": [
                    "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
            ]
        }
    },
    "index": 0,
    "name": "string"
}
string
action
Required  

The action to take. Enum options - BOT_ACTION_BYPASS, BOT_ACTION_CONTINUE. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

condition
Required  

condition

integer As uint32 As uint32
index
Required  

Rules are processed in order of this index field. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Optional

A name describing the rule in a short form. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

Property Of