.. _ddos_dst_zone_port_range_pattern_recognition:

ddos dst zone port-range pattern-recognition
============================================

Enable Pattern Recognition


pattern-recognition Specification
---------------------------------

	===================================== ================================================================================================================================================
	 **Parameter**                         **Value** 

	===================================== ================================================================================================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      pattern-recognition

	 **Element URI**                       /axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition

	 **Element Attributes**                pattern-recognition_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition/oper

	 **Schema**                             :download:`pattern-recognition schema <ddos-dst-zone-port-range-pattern-recognition/ddos-dst-zone-port-range-pattern-recognition.txt>`
	===================================== ================================================================================================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition



.. raw:: html

   </td><td valign = 'top'>


:ref:`918_pattern-recognition_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition



.. raw:: html

   </td><td valign = 'top'>


:ref:`918_pattern-recognition_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition



.. raw:: html

   </td><td valign = 'top'>


:ref:`918_pattern-recognition_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition



.. raw:: html

   </td><td valign = 'top'>


:ref:`918_pattern-recognition_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/pattern-recognition



.. raw:: html

   </td><td valign = 'top'>


:ref:`918_pattern-recognition_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _918_pattern-recognition_attributes:

pattern-recognition attributes
------------------------------

    **algorithm**

        **Description** 'heuristic': heuristic algorithm; 

        **Type:** string

        **Supported Values:** heuristic

    **app-payload-offset**

        **Description** Set offset of the payload, default 0

        **Type:** number

        **Range:** 0-1500

    **capture-traffic**

        **Description** 'all': Capture all packets; 'dropped': Capture dropped packets (default); 

        **Type:** string

        **Supported Values:** all, dropped

    **filter-inactive-threshold**

        **Description** Extracted filter inactive threshold

        **Type:** number

        **Range:** 5-255

    **filter-threshold**

        **Description** Extracted filter threshold

        **Type:** number

        **Range:** 0-100

    **mode**

        **Description** 'capture-never-expire': War-time capture without rate exceeding and never expires; 'manual': Manual mode; 

        **Type:** string

        **Supported Values:** capture-never-expire, manual

    **sensitivity**

        **Description** 'high': High Sensitivity; 'medium': Medium Sensitivity; 'low': Low Sensitivity; 

        **Type:** string

        **Supported Values:** high, medium, low

    **triggered-by**

        **Description** 'zone-escalation': Zone escalation trigger pattern recognition; 'packet-rate-exceeds': Packet rate limit exceeds trigger pattern recognition (default); 

        **Type:** string

        **Supported Values:** zone-escalation, packet-rate-exceeds

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters