.. _ddos_dst_default_port:

ddos dst default port
=====================

DDOS Port & Protocol configuration


port Specification
------------------

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

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

	 **Object Key(s)**                     *port-num, protocol*

	 **Collection Name**                   :ref:`704_port_list`

	 **Collection URI**                    /axapi/v3/ddos/dst/default/{default-address-type}/port

	                                       

	 **Element Name**                      port

	 **Element URI**                       /axapi/v3/ddos/dst/default/{default-address-type}/port/{port-num}+{protocol}

	 **Element Attributes**                port_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`port schema <ddos-dst-default-port/ddos-dst-default-port.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/default/{default-address-type}/port



.. raw:: html

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


:ref:`704_port_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/default/{default-address-type}/port



.. raw:: html

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


:ref:`704_port_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/default/{default-address-type}/port/{port-num}+{protocol}



.. raw:: html

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


:ref:`704_port_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/default/{default-address-type}/port



.. raw:: html

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


:ref:`704_port_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/default/{default-address-type}/port/{port-num}+{protocol}



.. raw:: html

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


:ref:`704_port_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/default/{default-address-type}/port/{port-num}+{protocol}



.. raw:: html

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


:ref:`704_port_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/default/{default-address-type}/port



.. raw:: html

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


:ref:`704_port_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/default/{default-address-type}/port/{port-num}+{protocol}



.. raw:: html

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


:ref:`704_port_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _704_port_list:

port-list
---------


    port-list is **JSON List** of :ref:`704_port_attributes` 

        port-list : [

             { :ref:`704_port_attributes` },

             { :ref:`704_port_attributes` },

             ...

         ]

.. _704_port_attributes:

port attributes
---------------

    **deny**

        **Description** Blacklist and Drop all incoming packets for protocol

        **Type:** boolean

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

        **Default:** 0

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

    **port-num**

        **Description** Port Number

        **Type:** number

        **Range:** 0-65535

    **protocol**

        **Description** 'dns-tcp': dns-tcp; 'dns-udp': dns-udp; 'http': http; 'tcp': tcp; 'udp': udp; 'ssl-l4': ssl-l4; 'sip-udp': sip-udp; 'sip-tcp': sip-tcp; 

        **Type:** string

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

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`704_template` 

        **Type:** Object

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

.. _704_template:

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

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

    **dns**

        **Description** DDOS dns template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **http**

        **Description** DDOS http template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **sip**

        **Description** DDOS sip template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **ssl-l4**

        **Description** DDOS ssl-l4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **tcp**

        **Description** DDOS tcp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **udp**

        **Description** DDOS udp template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters