.. _ddos_violation_actions:

ddos violation-actions
======================

Violation Actions Configuration


violation-actions Specification
-------------------------------

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

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

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

	 **Collection Name**                   :ref:`1227_violation-actions_list`

	 **Collection URI**                    /axapi/v3/ddos/violation-actions

	                                       

	 **Element Name**                      violation-actions

	 **Element URI**                       /axapi/v3/ddos/violation-actions/{name}

	 **Element Attributes**                violation-actions_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1227_violation-actions_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_violation_actions_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/violation-actions



.. raw:: html

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


:ref:`1227_violation-actions_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/violation-actions/{name}



.. raw:: html

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


:ref:`1227_violation-actions_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/ddos_violation_actions_GET.txt
   :literal:




.. raw:: html

   </div></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/violation-actions



.. raw:: html

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


:ref:`1227_violation-actions_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/violation-actions/{name}



.. raw:: html

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


:ref:`1227_violation-actions_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/violation-actions/{name}



.. raw:: html

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


:ref:`1227_violation-actions_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/ddos_violation_actions_PUT.txt
   :literal:




.. raw:: html

   </div></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/violation-actions



.. raw:: html

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


:ref:`1227_violation-actions_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/violation-actions/{name}



.. raw:: html

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


:ref:`1227_violation-actions_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/ddos_violation_actions_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1227_violation-actions_list:

violation-actions-list
----------------------


    violation-actions-list is **JSON List** of :ref:`1227_violation-actions_attributes` 

        violation-actions-list : [

             { :ref:`1227_violation-actions_attributes` },

             { :ref:`1227_violation-actions_attributes` },

             ...

         ]

.. _1227_violation-actions_attributes:

violation-actions attributes
----------------------------

    **blackhole**

        **Description** Blackhole the zone (in minute, 0 means infinite)

        **Type:** number

        **Range:** 0-30

    **blacklist-src**

        **Description** Blacklist-src (in min) (applied only for source action)

        **Type:** number

        **Range:** 1-30

    **execute-script**

        **Description** Specify DDOS script to run (applied only for zone action)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **execute-script-timeout**

        **Description** Timeout for script execution (in seconds) (applied only for zone action)

        **Type:** number

        **Range:** 5-20

    **name**

        **Description** DDOS violation-actions name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **notification**

        **Type:** List

    **send-notification-only**

        **Description** Forces TPS to only send out notification for the violation-action

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

.. _1227_notification:

notification
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **notification-template**

        **Description** Specify the notification template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/notification-template <ddos_notification_template>`