.. _ddos_zone_template_ips:

ddos zone-template ips
======================

IPS template configuration


ips Specification
-----------------

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

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

	 **Object Key(s)**                     *ips-tmpl-name*

	 **Collection Name**                   :ref:`1219_ips_list`

	 **Collection URI**                    /axapi/v3/ddos/zone-template/ips

	                                       

	 **Element Name**                      ips

	 **Element URI**                       /axapi/v3/ddos/zone-template/ips/{ips-tmpl-name}

	 **Element Attributes**                ips_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`ips schema <ddos-zone-template-ips/ddos-zone-template-ips.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/zone-template/ips



.. raw:: html

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


:ref:`1219_ips_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/zone-template/ips



.. raw:: html

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


:ref:`1219_ips_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/zone-template/ips/{ips-tmpl-name}



.. raw:: html

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


:ref:`1219_ips_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/zone-template/ips



.. raw:: html

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


:ref:`1219_ips_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/zone-template/ips/{ips-tmpl-name}



.. raw:: html

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


:ref:`1219_ips_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/zone-template/ips/{ips-tmpl-name}



.. raw:: html

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


:ref:`1219_ips_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/zone-template/ips



.. raw:: html

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


:ref:`1219_ips_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/zone-template/ips/{ips-tmpl-name}



.. raw:: html

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


:ref:`1219_ips_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1219_ips_list:

ips-list
--------


    ips-list is **JSON List** of :ref:`1219_ips_attributes` 

        ips-list : [

             { :ref:`1219_ips_attributes` },

             { :ref:`1219_ips_attributes` },

             ...

         ]

.. _1219_ips_attributes:

ips attributes
--------------

    **high-serverity-action-list-name**

        **Description** Configure action-list to take for high serverity signature

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **ips-profile-list**

        **Type:** List

    **ips-tmpl-name**

        **Description** DDOS IPS Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **low-serverity-action-list-name**

        **Description** Configure action-list to take for low serverity signature

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **medium-serverity-action-list-name**

        **Description** Configure action-list to take for medium serverity signature

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **streaming-scan-disable**

        **Description** Disable IPS streaming scan

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

.. _1219_ips-profile-list:

ips-profile-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ips-profile-name**

        **Description** IPS Profile Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters