HTTPSecurityRule

HTTPSecurityRule
HTTPSecurityRule
JSON Example
{
    "action": {
        "action": "string",
        "file": {
            "content_type": "string",
            "file_content": "string",
            "file_length": 0
        },
        "https_port": 0,
        "rate_profile": {
            "action": {
                "file": {
                    "content_type": "string",
                    "file_content": "string",
                    "file_length": 0
                },
                "redirect": {
                    "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"
                },
                "status_code": "string",
                "type": "string"
            },
            "per_client_ip": false,
            "per_uri_path": false,
            "rate_limiter": {
                "burst_sz": 0,
                "count": 0,
                "name": "string",
                "period": 0
            }
        },
        "status_code": "string"
    },
    "enable": false,
    "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"
}
action
Optional

action

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.

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.

match
Optional

match

string
name
Required

Name of the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.