LabelUsageEntry

LabelUsageEntry
LabelUsageEntry
JSON Example
{
    "apipath_uuid": "string",
    "enabled": false,
    "endpoint_count": 0,
    "endpoint_type": "string",
    "http_method": "string",
    "inherited": false,
    "label_mapping_actions": [
        "string"
    ],
    "location": "string",
    "path_template": "string",
    "policy_field": "string",
    "policy_uuid": "string",
    "rule": {
        "authentication_rule": {
            "action": {
                "type": "string"
            },
            "enable": false,
            "index": 0,
            "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"
                            }
                        }
                    ]
                },
                "host_hdr": {
                    "match_case": "string",
                    "match_criteria": "string",
                    "value": [
                        "string"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "string"
                    ]
                },
                "path": {
                    "match_case": "string",
                    "match_criteria": "string",
                    "match_decoded_string": false,
                    "match_str": [
                        "string"
                    ],
                    "string_group_refs": [
                        "string"
                    ]
                }
            },
            "name": "string"
        },
        "authorization_rule": {
            "action": {
                "status_code": "string",
                "type": "string"
            },
            "enable": false,
            "index": 0,
            "match": {
                "access_token": {
                    "matches": [
                        {
                            "bool_match": false,
                            "int_match": 0,
                            "is_mandatory": false,
                            "name": "string",
                            "string_match": {
                                "match_criteria": "string",
                                "match_str": [
                                    "string"
                                ],
                                "string_group_refs": [
                                    "string"
                                ]
                            },
                            "type": "string",
                            "validate": false
                        }
                    ],
                    "token_name": "string"
                },
                "attr_matches": [
                    {
                        "attribute_name": "string",
                        "attribute_value_list": {
                            "match_criteria": "string",
                            "match_str": [
                                "string"
                            ],
                            "string_group_refs": [
                                "string"
                            ]
                        }
                    }
                ],
                "host_hdr": {
                    "match_case": "string",
                    "match_criteria": "string",
                    "value": [
                        "string"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "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"
                    ]
                }
            },
            "name": "string"
        },
        "bot_rule": {
            "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"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "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"
        },
        "csrf_rule": {
            "action": "string",
            "enable": false,
            "index": 0,
            "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",
                        "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"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "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"
        },
        "http_request_rule": {
            "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",
                        "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"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "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"
                },
                "other_status_code": 0,
                "pool_group_ref": "string",
                "pool_ref": "string",
                "server": {
                    "hostname": "string",
                    "ip": {
                        "addr": "string",
                        "type": "string"
                    },
                    "port": 0
                },
                "status_code": "string"
            }
        },
        "http_response_rule": {
            "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",
                        "string_group_refs": [
                            "string"
                        ],
                        "value": [
                            "string"
                        ]
                    }
                ],
                "host_hdr": {
                    "match_case": "string",
                    "match_criteria": "string",
                    "value": [
                        "string"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "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",
                        "string_group_refs": [
                            "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"
        },
        "http_security_rule": {
            "action": {
                "action": "string",
                "file": {
                    "content_type": "string",
                    "file_content": "string"
                },
                "https_port": 0,
                "rate_profile": {
                    "action": {
                        "file": {
                            "content_type": "string",
                            "file_content": "string"
                        },
                        "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",
                        "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"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "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"
        },
        "waf_rule": {
            "actions": [
                "string"
            ],
            "description": "string",
            "enable": false,
            "index": 0,
            "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",
                        "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"
                    ]
                },
                "label": {
                    "match_criteria": "string",
                    "values": [
                        "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",
            "sampling_percent": 0
        }
    },
    "scope": "string"
}
string
apipath_uuid
Optional

UUID of the ApiPath. Set when location is LOCATION_API_ENDPOINT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enabled
Optional

This entry's own enabled/disabled toggle the endpoint, container, mapping, or rule's own enabled state. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
endpoint_count
Optional

Number of endpoints this container currently reaches. Omitted for shadow_api_labels/non_api_url_labels. Set when location is LOCATION_API_POLICY. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
endpoint_type
Optional

OZA classification of the endpoint. Set when location is LOCATION_API_ENDPOINT. Enum options - API_TYPE_ACTIVE, API_TYPE_ORPHAN, API_TYPE_ZOMBIE. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
http_method
Optional

HTTP method of the endpoint. Set when location is LOCATION_API_ENDPOINT. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
inherited
Optional

false when the label is set directly on the endpoint, true when inherited from the parent ApiPolicy. Set when location is LOCATION_API_ENDPOINT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
label_mapping_actions
Optional

ApiPolicyLabelMappingAction values this mapping enables. Set when location is LOCATION_API_POLICY_MAPPING. Enum options - API_POLICY_LABEL_ACTION_DEACTIVATE_PATH_PARAM_CHECK, API_POLICY_LABEL_ACTION_DEACTIVATE_QUERY_PARAM_CHECK, API_POLICY_LABEL_ACTION_DEACTIVATE_HEADER_CHECK, API_POLICY_LABEL_ACTION_DEACTIVATE_REQUEST_BODY_CHECK. Field introduced in 32.1.4. Maximum of 16 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
location
Optional

Which of the four locations this entry represents. Enum options - LOCATION_API_ENDPOINT, LOCATION_API_POLICY, LOCATION_API_POLICY_MAPPING, LOCATION_POLICY_RULE. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
path_template
Optional

URI path template, for readability only. Set when location is LOCATION_API_ENDPOINT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
policy_field
Optional

The ApiPolicy label container this entry is from active_api_labels, shadow_api_labels, orphan_api_labels, zombie_api_labels, or non_api_url_labels. Set when location is LOCATION_API_POLICY. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
policy_uuid
Optional

UUID of the owning top-level policy object. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

rule
Optional

rule

string
scope
Optional

The policy scope this entry belongs to MATCH_ACTION_SCOPE_APIPOLICY for every location except policy_rule, which reports the specific scope of the matched rule's own policy. Enum options - MATCH_ACTION_SCOPE_GENERIC, MATCH_ACTION_SCOPE_APIPOLICY, MATCH_ACTION_SCOPE_WAFPOLICY, MATCH_ACTION_SCOPE_HTTPSECURITYPOLICY, MATCH_ACTION_SCOPE_HTTPREQUESTPOLICY, MATCH_ACTION_SCOPE_HTTPRESPONSEPOLICY, MATCH_ACTION_SCOPE_CSRFPOLICY, MATCH_ACTION_SCOPE_AUTHPROFILE, MATCH_ACTION_SCOPE_VSDATASCRIPTSET, MATCH_ACTION_SCOPE_BOTDETECTIONPOLICY. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.