.. _ddos_dst_zone_detection_victim_ip_detection:

ddos dst zone detection victim-ip-detection
===========================================

DDos Host Detections configuration


victim-ip-detection Specification
---------------------------------

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

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

	 **Element Name**                      victim-ip-detection

	 **Element URI**                       /axapi/v3/ddos/dst/zone/{zone-name}/detection/victim-ip-detection

	 **Element Attributes**                victim-ip-detection_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/ddos/dst/zone/{zone-name}/detection/victim-ip-detection/oper

	 **Schema**                             :download:`victim-ip-detection schema <ddos-dst-zone-detection-victim-ip-detection/ddos-dst-zone-detection-victim-ip-detection.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}/detection/victim-ip-detection



.. raw:: html

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


:ref:`845_victim-ip-detection_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/ddos_dst_zone_detection_victim_ip_detection_POST.txt
   :literal:




.. raw:: html

   </div></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}/detection/victim-ip-detection



.. raw:: html

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


:ref:`845_victim-ip-detection_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/ddos_dst_zone_detection_victim_ip_detection_GET.txt
   :literal:




.. raw:: html

   </div></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}/detection/victim-ip-detection



.. raw:: html

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


:ref:`845_victim-ip-detection_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}/detection/victim-ip-detection



.. raw:: html

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


:ref:`845_victim-ip-detection_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/ddos_dst_zone_detection_victim_ip_detection_PUT.txt
   :literal:




.. raw:: html

   </div></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}/detection/victim-ip-detection



.. raw:: html

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


:ref:`845_victim-ip-detection_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/ddos_dst_zone_detection_victim_ip_detection_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _845_victim-ip-detection_attributes:

victim-ip-detection attributes
------------------------------

    **configuration**

        **Description** 'configuration': configuration; 

        **Type:** string

        **Supported Values:** configuration

    **histogram-toggle**

        **Description** 'histogram-enable': Enable histogram statistics of victim IP detection; 'histogram-disable': Disable histogram statistics of victim IP detection; 

        **Type:** string

        **Supported Values:** histogram-enable, histogram-disable

        **Default:** histogram-disable

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/detection/victim-ip-detection/indicator/{type} <ddos_dst_zone>`

    **toggle**

        **Description** 'enable': Enable victim IP detection; 'disable': Disable victim IP detection; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _845_indicator-list:

indicator-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ip-threshold-num**

        **Description** Threshold for IP

        **Type:** number

        **Range:** 1-2147483647

    **type**

        **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; 

        **Type:** string

        **Supported Values:** pkt-rate, reverse-pkt-rate, fwd-byte-rate, rev-byte-rate

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters