HTTPResponseRule

HTTPResponseRule

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,
    "loc_hdr_action": {
        "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"
    },
    "log": false,
    "match": {
        "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"
        },
        "hdrs": [
            {
                "hdr": "string",
                "match_case": "string",
                "match_criteria": "string",
                "value": [
                    "string"
                ]
            }
        ],
        "host_hdr": {
            "match_case": "string",
            "match_criteria": "string",
            "value": [
                "string"
            ]
        },
        "loc_hdr": {
            "match_case": "string",
            "match_criteria": "string",
            "value": [
                "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"
            ]
        },
        "rsp_hdrs": [
            {
                "hdr": "string",
                "match_case": "string",
                "match_criteria": "string",
                "value": [
                    "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"
                    }
                }
            ]
        },
        "status": {
            "match_criteria": "string",
            "ranges": [
                {
                    "begin": 0,
                    "end": 0
                }
            ],
            "status_codes": [
                0
            ]
        },
        "version": {
            "match_criteria": "string",
            "versions": [
                "string"
            ]
        },
        "vs_port": {
            "match_criteria": "string",
            "ports": [
                0
            ]
        }
    },
    "name": "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.

HTTPRewriteLocHdrAction

loc_hdr_action

Optional

loc_hdr_action

boolean

log

Optional

Log HTTP request upon rule match. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ResponseMatchTarget

match

Optional

match

string

name

Required

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

Property Of

HTTPResponsePolicy