.. _ddos_dst_zone_web_gui:

ddos dst zone web-gui
=====================

Configure web settings for onbox GUI


web-gui Specification
---------------------

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

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

	 **Element Name**                      web-gui

	 **Element URI**                       /axapi/v3/ddos/dst/zone/{zone-name}/web-gui

	 **Element Attributes**                web-gui_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1046_web-gui_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}/web-gui



.. raw:: html

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


:ref:`1046_web-gui_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}/web-gui



.. raw:: html

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


:ref:`1046_web-gui_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}/web-gui



.. raw:: html

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


:ref:`1046_web-gui_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}/web-gui



.. raw:: html

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


:ref:`1046_web-gui_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1046_web-gui_attributes:

web-gui attributes
------------------

    **activated-after-learning**

        **Description** Activate it after learning

        **Type:** boolean

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

        **Default:** 0

    **create-time**

        **Description** Configure create time

        **Type:** string

        **Maximum Length:** 13 characters

        **Maximum Length:** 1 characters

    **learning**

        **Description:** learning is a **JSON Block**.  Please see below for :ref:`1046_learning` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/learning <ddos_dst_zone>`

    **modify-time**

        **Description** Configure modify time

        **Type:** string

        **Maximum Length:** 13 characters

        **Maximum Length:** 1 characters

    **protection**

        **Description:** protection is a **JSON Block**.  Please see below for :ref:`1046_protection` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection <ddos_dst_zone>`

    **sensitivity**

        **Description** '5': Low; '3': Medium; '1.5': High; 

        **Type:** string

        **Supported Values:** 5, 3, 1.5

        **Default:** 3

    **status**

        **Description** 'newly': newly; 'learning': learning; 'learned': learned; 'activated': activated; 

        **Type:** string

        **Supported Values:** newly, learning, learned, activated

        **Default:** newly

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1046_protection:

protection
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-proto**

        **Description:** ip-proto is a **JSON Block**.  Please see below for :ref:`1046_protection_ip-proto` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/ip-proto <ddos_dst_zone>`

    **port**

        **Description:** port is a **JSON Block**.  Please see below for :ref:`1046_protection_port` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port <ddos_dst_zone>`

    **port-range-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port-range/{port-range-start}+{port-range-end}+{protocol} <ddos_dst_zone>`

.. _1046_protection_port-range-list:

protection_port-range-list
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **pbe**

        **Description** Peak Bandwidth Expected

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **port-range-end**

        **Description** Port-Range End Port Number

        **Type:** number

        **Range:** 1-65535

    **port-range-start**

        **Description** Port-Range Start Port Number

        **Type:** number

        **Range:** 1-65535

    **protocol**

        **Description** 'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 

        **Type:** string

        **Supported Values:** dns-tcp, dns-udp, http, tcp, udp, ssl-l4

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

.. _1046_protection_port:

protection_port
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **zone-service-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port/zone-service/{port-num}+{protocol} <ddos_dst_zone>`

    **zone-service-other-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port/zone-service-other/{port-other}+{protocol} <ddos_dst_zone>`

.. _1046_protection_port_zone-service-list:

protection_port_zone-service-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **pbe**

        **Description** Peak Bandwidth Expected

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 1-65535

    **protocol**

        **Description** 'dns-tcp': DNS-TCP Port; 'dns-udp': DNS-UDP Port; 'http': HTTP Port; 'tcp': TCP Port; 'udp': UDP Port; 'ssl-l4': SSL-L4 Port; 

        **Type:** string

        **Supported Values:** dns-tcp, dns-udp, http, tcp, udp, ssl-l4

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1046_protection_port_zone-service-other-list:

protection_port_zone-service-other-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **pbe**

        **Description** Peak Bandwidth Expected

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **port-other**

        **Description** 'other': other; 

        **Type:** string

        **Supported Values:** other

    **protocol**

        **Description** 'tcp': TCP Port; 'udp': UDP Port; 

        **Type:** string

        **Supported Values:** tcp, udp

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1046_protection_ip-proto:

protection_ip-proto
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **proto-name-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/ip-proto/proto-name/{protocol} <ddos_dst_zone>`

.. _1046_protection_ip-proto_proto-name-list:

protection_ip-proto_proto-name-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **pbe**

        **Description** Peak Bandwidth Expected

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **protocol**

        **Description** 'icmp-v4': ip-proto icmp-v4; 'icmp-v6': ip-proto icmp-v6; 

        **Type:** string

        **Supported Values:** icmp-v4, icmp-v6

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

.. _1046_learning:

learning
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **duration**

        **Description** '1minute': 1 minute; '6hour': 6 hours; '12hour': 12 hours; '24hour': 24 hours; '7day': 7 days; 

        **Type:** string

        **Supported Values:** 1minute, 6hour, 12hour, 24hour, 7day

        **Default:** 6hour

    **starting-time**

        **Description** Configure learning starting time

        **Type:** string

        **Maximum Length:** 13 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters