{
    "id":"/axapi/v3/ddos/dst/zone/{zone-name}/detection",
    "type":"object",
    "node-type":"scalar",
    "title":"detection",
    "partition-visibility":"shared",
    "description":"DDOS Detection",
    "properties":{
        "settings":{
            "type":"string",
            "format":"enum",
            "partition-visibility":"shared",
            "description":"'settings': settings; ",
            "enum":[
                "settings"
            ],
            "optional":false
        },
        "toggle":{
            "type":"string",
            "format":"enum",
            "default":"enable",
            "partition-visibility":"shared",
            "description":"'enable': Enable detection; 'disable': Disable detection; ",
            "enum":[
                "enable",
                "disable"
            ],
            "optional":true
        },
        "uuid":{
            "type":"string",
            "format":"string",
            "minLength":1,
            "maxLength":64,
            "partition-visibility":"shared",
            "modify-not-allowed":1,
            "description":"uuid of the object",
            "optional":true
        },
        "notification":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/notification",
            "properties":{
                "configuration":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'configuration': configuration; ",
                    "enum":[
                        "configuration"
                    ]
                },
                "notification":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "notification-template-name":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":63,
                                    "partition-visibility":"shared",
                                    "$ref":"/axapi/v3/ddos/notification-template",
                                    "description":"Specify the notification template name"
                                }
                            }
                        }
                    ]
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "outbound-detection":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/outbound-detection",
            "properties":{
                "configuration":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'configuration': configuration; ",
                    "enum":[
                        "configuration"
                    ]
                },
                "toggle":{
                    "type":"string",
                    "format":"enum",
                    "default":"disable",
                    "partition-visibility":"shared",
                    "description":"'enable': Enable outbound detection; 'disable': Disable outbound detection; ",
                    "enum":[
                        "enable",
                        "disable"
                    ]
                },
                "discovery-method":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'asn': Autonomous Systems number; 'country': Country; ",
                    "enum":[
                        "asn",
                        "country"
                    ]
                },
                "discovery-record":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100,
                    "default":10,
                    "partition-visibility":"shared",
                    "description":"Maximum number of top locations"
                },
                "enable-top-k":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "topk-type":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'source-subnet': Topk source subnet; ",
                                    "enum":[
                                        "source-subnet"
                                    ]
                                },
                                "topk-netmask":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":128,
                                    "default":128,
                                    "partition-visibility":"shared",
                                    "description":"Subnet mask. The value should be less than or equal to the minimum zone subnet mask + 8 (IPv6 Subnet mask)"
                                },
                                "topk-num-records":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":100,
                                    "default":20,
                                    "partition-visibility":"shared",
                                    "description":"Maximum number of records to show in topk"
                                }
                            }
                        }
                    ]
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "indicator-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"indicator"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/outbound-detection/indicator/{type}",
                    "array":[
                        {
                            "properties":{
                                "type":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'pkt-rate': rate of incoming packets; 'pkt-drop-rate': rate of packets got dropped; 'bit-rate': rate of incoming bits; 'pkt-drop-ratio': ratio of incoming packet rate divided by the rate of dropping packets; 'bytes-to-bytes-from-ratio': ratio of incoming packet rate divided by the rate of outgoing packets; 'syn-rate': rate on incoming SYN packets; 'fin-rate': rate on incoming FIN packets; 'rst-rate': rate of incoming RST packets; 'small-window-ack-rate': rate of small window advertisement; 'empty-ack-rate': rate of incoming packets which have no payload; 'small-payload-rate': rate of short payload packet; 'syn-fin-ratio': ratio of incoming SYN packet rate divided by the rate of incoming FIN packets; ",
                                    "enum":[
                                        "pkt-rate",
                                        "pkt-drop-rate",
                                        "bit-rate",
                                        "pkt-drop-ratio",
                                        "bytes-to-bytes-from-ratio",
                                        "syn-rate",
                                        "fin-rate",
                                        "rst-rate",
                                        "small-window-ack-rate",
                                        "empty-ack-rate",
                                        "small-payload-rate",
                                        "syn-fin-ratio"
                                    ],
                                    "optional":false
                                },
                                "tcp-window-size":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":500,
                                    "partition-visibility":"shared",
                                    "description":"Expected minimal window size",
                                    "optional":true
                                },
                                "data-packet-size":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":1500,
                                    "partition-visibility":"shared",
                                    "description":"Expected minimal data size",
                                    "optional":true
                                },
                                "threshold-num":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":2147483647,
                                    "partition-visibility":"shared",
                                    "description":"Threshold for each geo-location",
                                    "optional":true
                                },
                                "threshold-large-num":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":10995116277760,
                                    "partition-visibility":"shared",
                                    "description":"Threshold for each geo-location",
                                    "optional":true
                                },
                                "threshold-str":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":128,
                                    "partition-visibility":"shared",
                                    "description":"Threshold for each geo-location (Non-zero floating point)",
                                    "optional":true
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                },
                                "user-tag":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":127,
                                    "partition-visibility":"shared",
                                    "description":"Customized tag",
                                    "optional":true
                                }
                            },
                            "required":[
                                "type"
                            ]
                        }
                    ]
                },
                "topk-source-subnet":{
                    "type":"object",
                    "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/outbound-detection/topk-source-subnet",
                    "properties":{
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object"
                        }
                    }
                }
            }
        },
        "service-discovery":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/service-discovery",
            "properties":{
                "configuration":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'configuration': configuration; ",
                    "enum":[
                        "configuration"
                    ]
                },
                "toggle":{
                    "type":"string",
                    "format":"enum",
                    "default":"disable",
                    "partition-visibility":"shared",
                    "description":"'enable': Enable service discovery; 'disable': Disable service discovery; ",
                    "enum":[
                        "enable",
                        "disable"
                    ]
                },
                "pkt-rate-threshold":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":255,
                    "default":10,
                    "partition-visibility":"shared",
                    "description":"packet rate threshold for discovery (default 10 packets per second)"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "packet-anomaly-detection":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/packet-anomaly-detection",
            "properties":{
                "configuration":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'configuration': configuration; ",
                    "enum":[
                        "configuration"
                    ]
                },
                "toggle":{
                    "type":"string",
                    "format":"enum",
                    "default":"enable",
                    "partition-visibility":"shared",
                    "description":"'enable': Enable packet anomaly; 'disable': Disable packet anomaly; ",
                    "enum":[
                        "enable",
                        "disable"
                    ]
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "indicator-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"indicator"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/packet-anomaly-detection/indicator/{type}",
                    "array":[
                        {
                            "properties":{
                                "type":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'port-zero-pkt-rate': Port Zero Packet Rate (default 100 packet per second); ",
                                    "enum":[
                                        "port-zero-pkt-rate"
                                    ],
                                    "optional":false
                                },
                                "threshold-num":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":65535,
                                    "default":100,
                                    "partition-visibility":"shared",
                                    "description":"Threshold for each indicator",
                                    "optional":true
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                },
                                "user-tag":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":127,
                                    "partition-visibility":"shared",
                                    "description":"Customized tag",
                                    "optional":true
                                }
                            },
                            "required":[
                                "type"
                            ]
                        }
                    ]
                }
            }
        },
        "victim-ip-detection":{
            "type":"object",
            "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/victim-ip-detection",
            "properties":{
                "configuration":{
                    "type":"string",
                    "format":"enum",
                    "partition-visibility":"shared",
                    "description":"'configuration': configuration; ",
                    "enum":[
                        "configuration"
                    ]
                },
                "toggle":{
                    "type":"string",
                    "format":"enum",
                    "default":"disable",
                    "partition-visibility":"shared",
                    "description":"'enable': Enable victim IP detection; 'disable': Disable victim IP detection; ",
                    "enum":[
                        "enable",
                        "disable"
                    ]
                },
                "histogram-toggle":{
                    "type":"string",
                    "format":"enum",
                    "default":"histogram-disable",
                    "partition-visibility":"shared",
                    "description":"'histogram-enable': Enable histogram statistics of victim IP detection; 'histogram-disable': Disable histogram statistics of victim IP detection; ",
                    "enum":[
                        "histogram-enable",
                        "histogram-disable"
                    ]
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "indicator-list":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"indicator"
                    },
                    "uniqueItems":true,
                    "$ref":"/axapi/v3/ddos/dst/zone/{zone-name}/detection/victim-ip-detection/indicator/{type}",
                    "array":[
                        {
                            "properties":{
                                "type":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'pkt-rate': rate of incoming packets; 'reverse-pkt-rate': rate of reverse coming packets; 'fwd-byte-rate': rate of incoming bytes; 'rev-byte-rate': rate of reverse coming bytes; ",
                                    "enum":[
                                        "pkt-rate",
                                        "reverse-pkt-rate",
                                        "fwd-byte-rate",
                                        "rev-byte-rate"
                                    ],
                                    "optional":false
                                },
                                "ip-threshold-num":{
                                    "type":"number",
                                    "format":"number",
                                    "minimum":1,
                                    "maximum":2147483647,
                                    "partition-visibility":"shared",
                                    "description":"Threshold for IP",
                                    "optional":true
                                },
                                "uuid":{
                                    "type":"string",
                                    "format":"string",
                                    "minLength":1,
                                    "maxLength":64,
                                    "partition-visibility":"shared",
                                    "modify-not-allowed":1,
                                    "description":"uuid of the object",
                                    "optional":true
                                },
                                "user-tag":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":127,
                                    "partition-visibility":"shared",
                                    "description":"Customized tag",
                                    "optional":true
                                }
                            },
                            "required":[
                                "type"
                            ]
                        }
                    ]
                }
            }
        }
    }
}