.. _ddos_zone_template_ip_proto:

ddos zone-template ip-proto
===========================

Ip-proto template configuration


ip-proto Specification
----------------------

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

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

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

	 **Collection Name**                   :ref:`1260_ip-proto_list`

	 **Collection URI**                    /axapi/v3/ddos/zone-template/ip-proto

	                                       

	 **Element Name**                      ip-proto

	 **Element URI**                       /axapi/v3/ddos/zone-template/ip-proto/{name}

	 **Element Attributes**                ip-proto_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1260_ip-proto_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_zone_template_ip_proto_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/zone-template/ip-proto



.. raw:: html

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


:ref:`1260_ip-proto_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/ip-proto/{name}



.. raw:: html

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


:ref:`1260_ip-proto_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_zone_template_ip_proto_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/zone-template/ip-proto



.. raw:: html

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


:ref:`1260_ip-proto_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/ip-proto/{name}



.. raw:: html

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


:ref:`1260_ip-proto_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/ip-proto/{name}



.. raw:: html

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


:ref:`1260_ip-proto_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_zone_template_ip_proto_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/zone-template/ip-proto



.. raw:: html

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


:ref:`1260_ip-proto_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/ip-proto/{name}



.. raw:: html

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


:ref:`1260_ip-proto_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_zone_template_ip_proto_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1260_ip-proto_list:

ip-proto-list
-------------


    ip-proto-list is **JSON List** of :ref:`1260_ip-proto_attributes` 

        ip-proto-list : [

             { :ref:`1260_ip-proto_attributes` },

             { :ref:`1260_ip-proto_attributes` },

             ...

         ]

.. _1260_ip-proto_attributes:

ip-proto attributes
-------------------

    **filter-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/zone-template/ip-proto/{name}/filter/{other-filter-name} <ddos_zone_template_ip_proto>`

    **filter-match-type**

        **Description** 'default': Stop matching on drop/blacklist action; 'stop-on-first-match': Stop matching on first match; 

        **Type:** string

        **Supported Values:** default, stop-on-first-match

        **Default:** default

    **name**

        **Description** DDOS Ip-proto Template 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

.. _1260_filter-list:

filter-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **byte-offset-filter**

        **Description** Filter using Berkeley Packet Filter syntax

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1275 characters

        **Maximum Length:** 1 characters

    **other-filter-action**

        **Description** 'drop': Drop packets (Default); 'ignore': Take no action; 'blacklist-src': Blacklist-src; 'authenticate-src': Authenticate-src; 

        **Type:** string

        **Supported Values:** drop, ignore, blacklist-src, authenticate-src

        **Mutual Exclusion:** other-filter-action and other-filter-action-list-name are mutually exclusive

    **other-filter-action-list-name**

        **Description** Configure action-list to take

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** other-filter-action-list-name and other-filter-action are mutually exclusive

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

    **other-filter-inverse-match**

        **Description** Inverse the result of the matching

        **Type:** boolean

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

        **Default:** 0

    **other-filter-name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **other-filter-regex**

        **Description** Regex Expression

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 1275 characters

        **Maximum Length:** 1 characters

    **other-filter-seq**

        **Description** Sequence number

        **Type:** number

        **Range:** 1-200

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