.. _ddos_dst_zone_detection_outbound_detection:

ddos dst zone detection outbound-detection
==========================================

DDOS Outbound Detection


outbound-detection Specification
--------------------------------

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

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

	 **Element Name**                      outbound-detection

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

	 **Element Attributes**                outbound-detection_attributes

	 **Partition Visibility**              shared

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

	 **Schema**                             :download:`outbound-detection schema <ddos-dst-zone-detection-outbound-detection/ddos-dst-zone-detection-outbound-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/outbound-detection



.. raw:: html

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


:ref:`838_outbound-detection_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}/detection/outbound-detection



.. raw:: html

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


:ref:`838_outbound-detection_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}/detection/outbound-detection



.. raw:: html

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


:ref:`838_outbound-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/outbound-detection



.. raw:: html

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


:ref:`838_outbound-detection_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}/detection/outbound-detection



.. raw:: html

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


:ref:`838_outbound-detection_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _838_outbound-detection_attributes:

outbound-detection attributes
-----------------------------

    **configuration**

        **Description** 'configuration': configuration; 

        **Type:** string

        **Supported Values:** configuration

    **discovery-method**

        **Description** 'asn': Autonomous Systems number; 'country': Country; 

        **Type:** string

        **Supported Values:** asn, country

    **discovery-record**

        **Description** Maximum number of top locations

        **Type:** number

        **Range:** 1-100

        **Default:** 10

    **enable-top-k**

        **Type:** List

    **indicator-list**

        **Type:** List

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

    **toggle**

        **Description** 'enable': Enable outbound detection; 'disable': Disable outbound detection; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **topk-source-subnet**

        **Description:** topk-source-subnet is a **JSON Block**.  Please see below for :ref:`838_topk-source-subnet` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/detection/outbound-detection/topk-source-subnet <ddos_dst_zone>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _838_topk-source-subnet:

topk-source-subnet
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _838_enable-top-k:

enable-top-k
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **topk-netmask**

        **Description** Subnet mask. The value should be less than or equal to the minimum zone subnet mask + 8 (IPv6 Subnet mask)

        **Type:** number

        **Range:** 1-128

        **Default:** 128

    **topk-num-records**

        **Description** Maximum number of records to show in topk

        **Type:** number

        **Range:** 1-100

        **Default:** 20

    **topk-type**

        **Description** 'source-subnet': Topk source subnet; 

        **Type:** string

        **Supported Values:** source-subnet

.. _838_indicator-list:

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

	 **Block object keys**             

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

    **data-packet-size**

        **Description** Expected minimal data size

        **Type:** number

        **Range:** 1-1500

    **tcp-window-size**

        **Description** Expected minimal window size

        **Type:** number

        **Range:** 1-500

    **threshold-large-num**

        **Description** Threshold for each geo-location

        **Type:** number

        **Range:** 1-10995116277760

    **threshold-num**

        **Description** Threshold for each geo-location

        **Type:** number

        **Range:** 1-2147483647

    **threshold-str**

        **Description** Threshold for each geo-location (Non-zero floating point)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **type**

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

        **Type:** string

        **Supported Values:** 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

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