.. _ddos_dst_zone_port_range_level:

ddos dst zone port-range level
==============================

Policy Level Configuration


level Specification
-------------------

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

	===================================== ==============================================================================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *level-num*

	 **Collection Name**                   :ref:`912_level_list`

	 **Collection URI**                    /axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/level

	                                       

	 **Element Name**                      level

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

	 **Element Attributes**                level_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`level schema <ddos-dst-zone-port-range-level/ddos-dst-zone-port-range-level.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}/level



.. raw:: html

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


:ref:`912_level_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. 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}/level



.. raw:: html

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


:ref:`912_level_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}/level/{level-num}



.. raw:: html

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


:ref:`912_level_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. 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}/level



.. raw:: html

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


:ref:`912_level_list`



.. 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}/level/{level-num}



.. raw:: html

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


:ref:`912_level_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}/level/{level-num}



.. raw:: html

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


:ref:`912_level_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. 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}/level



.. raw:: html

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


:ref:`912_level_list`



.. 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}/level/{level-num}



.. raw:: html

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


:ref:`912_level_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _912_level_list:

level-list
----------


    level-list is **JSON List** of :ref:`912_level_attributes` 

        level-list : [

             { :ref:`912_level_attributes` },

             { :ref:`912_level_attributes` },

             ...

         ]

.. _912_level_attributes:

level attributes
----------------

    **apply-extracted-filters**

        **Description** Apply extracted filters from this level

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **close-sessions-for-unauth-sources**

        **Description** Close session for unauthenticated sources

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **glid-action**

        **Description** 'drop': Drop packets for glid exceed (Default); 'blacklist-src': Blacklist-src for glid exceed; 'ignore': Do nothing for glid exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src, ignore

    **indicator-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/level/{level-num}/indicator/{type} <ddos_dst_zone>`

    **level-num**

        **Description** '0': Default policy level; '1': Policy level 1; '2': Policy level 2; '3': Policy level 3; '4': Policy level 4; 

        **Type:** string

        **Supported Values:** 0, 1, 2, 3, 4

    **src-default-glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **src-escalation-score**

        **Description** Source activation score of this level

        **Type:** number

        **Range:** 1-1000000

    **src-violation-actions**

        **Description** Violation actions apply due to source escalate from this level

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`

    **start-pattern-recognition**

        **Description** Start pattern recognition from this level

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

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

    **zone-escalation-score**

        **Description** Zone activation score of this level

        **Type:** number

        **Range:** 1-1000000

    **zone-template**

        **Description:** zone-template is a **JSON Block**.  Please see below for :ref:`912_zone-template` 

        **Type:** Object

    **zone-violation-actions**

        **Description** Violation actions apply due to zone escalate from this level

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`

.. _912_zone-template:

zone-template
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dns**

        **Description** DDOS dns template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **encap**

        **Description** DDOS encap template (IPv6-over-IPv4 / IPv4-over-IPv6 are not supported.)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **http**

        **Description** DDOS http template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **quic**

        **Description** DDOS quic template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sip**

        **Description** DDOS sip template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ssl-l4**

        **Description** DDOS ssl-l4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tcp**

        **Description** DDOS tcp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **udp**

        **Description** DDOS udp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _912_indicator-list:

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

	 **Block object keys**             

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

    **data-packet-size**

        **Description** Expected minimal data size

        **Type:** number

        **Range:** 1-1500

    **score**

        **Description** Score corresponding to the indicator

        **Type:** number

        **Range:** 1-1000000

    **src-threshold-large-num**

        **Description** Indicator per-src threshold

        **Type:** number

        **Range:** 1-10995116277760

    **src-threshold-num**

        **Description** Indicator per-src threshold

        **Type:** number

        **Range:** 1-2147483647

    **src-threshold-str**

        **Description** Indicator per-src threshold (Non-zero floating point)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **src-violation-actions**

        **Description** Violation actions to use when this src indicator threshold reaches

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`

    **tcp-window-size**

        **Description** Expected minimal window size

        **Type:** number

        **Range:** 1-500

    **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; 'concurrent-conns': number of concurrent connections; 'conn-miss-rate': rate of incoming packets for which no previously established connection exists; '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; 'cpu-utilization': average data CPU utilization; 'interface-utilization': outside interface utilization; 

        **Type:** string

        **Supported Values:** pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, concurrent-conns, conn-miss-rate, syn-rate, fin-rate, rst-rate, small-window-ack-rate, empty-ack-rate, small-payload-rate, syn-fin-ratio, cpu-utilization, interface-utilization

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

    **zone-threshold-large-num**

        **Description** Threshold for the entire zone

        **Type:** number

        **Range:** 1-10995116277760

    **zone-threshold-num**

        **Description** Threshold for the entire zone

        **Type:** number

        **Range:** 1-2147483647

    **zone-threshold-str**

        **Description** Threshold for the entire zone (Non-zero floating point)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **zone-violation-actions**

        **Description** Violation actions to use when this zone indicator threshold reaches

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/violation-actions <ddos_violation_actions>`