.. _ddos_action_list:

ddos action-list
================

Action List Configuration


action-list Specification
-------------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`653_action-list_list`

	 **Collection URI**                    /axapi/v3/ddos/action-list

	                                       

	 **Element Name**                      action-list

	 **Element URI**                       /axapi/v3/ddos/action-list/{name}

	 **Element Attributes**                action-list_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`action-list schema <ddos-action-list/ddos-action-list.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/action-list



.. raw:: html

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


:ref:`653_action-list_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_action_list_POST.txt
   :literal:




.. raw:: html

   </div></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/action-list



.. raw:: html

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


:ref:`653_action-list_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/action-list/{name}



.. raw:: html

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


:ref:`653_action-list_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/action-list



.. raw:: html

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


:ref:`653_action-list_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/action-list/{name}



.. raw:: html

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


:ref:`653_action-list_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/action-list/{name}



.. raw:: html

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


:ref:`653_action-list_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/action-list



.. raw:: html

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


:ref:`653_action-list_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/action-list/{name}



.. raw:: html

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


:ref:`653_action-list_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _653_action-list_list:

action-list-list
----------------


    action-list-list is **JSON List** of :ref:`653_action-list_attributes` 

        action-list-list : [

             { :ref:`653_action-list_attributes` },

             { :ref:`653_action-list_attributes` },

             ...

         ]

.. _653_action-list_attributes:

action-list attributes
----------------------

    **action**

        **Description:** action is a **JSON Block**.  Please see below for :ref:`653_action` 

        **Type:** Object

    **capture-config**

        **Description** capture-config name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/capture-config <capture_config>`

    **name**

        **Description** DDOS action-list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

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

        **Type:** Object

.. _653_zone-template:

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

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

    **encap**

        **Description** DDOS encap template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-template/encap <ddos_zone_template_encap>`

    **logging**

        **Description** DDOS logging zone-template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-template/logging <ddos_zone_template_logging>`

.. _653_action:

action
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **action**

        **Description** 'drop': Drop Packet (Default); 'ignore': Continue processing the packet; 'reset': Reset the connection; 'authenticate-src': Authenticate the source IP; 'blacklist-src': Black-list the source IP; 'tunnel-encap-packet': Encapsulate packet for tunneling. encap template need to be bound; 

        **Type:** string

        **Supported Values:** drop, ignore, reset, authenticate-src, blacklist-src, tunnel-encap-packet

    **blacklist-src-value**

        **Description** blacklist duration in minutes

        **Type:** number

        **Range:** 1-30

    **scrub-packet**

        **Description** allow packets to go through other DDoS checks before sent out

        **Type:** boolean

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

        **Default:** 0

    **stateless**

        **Description** encapsulate all packests

        **Type:** boolean

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

        **Default:** 0