.. _ddos_notification_template:

ddos notification-template
==========================

Notification template configuration


notification-template Specification
-----------------------------------

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

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

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

	 **Collection Name**                   :ref:`1066_notification-template_list`

	 **Collection URI**                    /axapi/v3/ddos/notification-template

	                                       

	 **Element Name**                      notification-template

	 **Element URI**                       /axapi/v3/ddos/notification-template/{name}

	 **Element Attributes**                notification-template_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1066_notification-template_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/notification-template



.. raw:: html

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


:ref:`1066_notification-template_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/notification-template/{name}



.. raw:: html

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


:ref:`1066_notification-template_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/notification-template



.. raw:: html

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


:ref:`1066_notification-template_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/notification-template/{name}



.. raw:: html

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


:ref:`1066_notification-template_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/notification-template/{name}



.. raw:: html

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


:ref:`1066_notification-template_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/notification-template



.. raw:: html

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


:ref:`1066_notification-template_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/notification-template/{name}



.. raw:: html

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


:ref:`1066_notification-template_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1066_notification-template_list:

notification-template-list
--------------------------


    notification-template-list is **JSON List** of :ref:`1066_notification-template_attributes` 

        notification-template-list : [

             { :ref:`1066_notification-template_attributes` },

             { :ref:`1066_notification-template_attributes` },

             ...

         ]

.. _1066_notification-template_attributes:

notification-template attributes
--------------------------------

    **api**

        **Description:** api is a **JSON Block**.  Please see below for :ref:`1066_api` 

        **Type:** Object

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

    **debug-mode**

        **Description** Enable debug mode

        **Type:** boolean

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

        **Default:** 0

    **disable**

        **Description** Disable the notification template (Disable notification temaplate)

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** DDOS nofitication template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **test-connectivity**

        **Description** Test connectivity to notification receiver

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

    **verbose**

        **Description** Dump zone IPs to the payload

        **Type:** boolean

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

        **Default:** 0

.. _1066_api:

api
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **authentication**

        **Description:** authentication is a **JSON Block**.  Please see below for :ref:`1066_api_authentication` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/notification-template/{name}/api/authentication <ddos_notification_template>`

    **disable-authentication**

        **Description** Disable authentication to communicate to the host

        **Type:** boolean

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

        **Default:** 0

    **host-ipv4-address**

        **Description** Configure the host IPv4 address to send notification (IPv4 address of the host)

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** host-ipv4-address, host-ipv6-address, and hostname are mutually exclusive

    **host-ipv6-address**

        **Description** Configure the host IPv6 address to send notification (IPv6 address of the host)

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** host-ipv6-address, host-ipv4-address, and hostname are mutually exclusive

    **hostname**

        **Description** host name(e.g www.a10networks.com)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** hostname, host-ipv4-address, and host-ipv6-address are mutually exclusive

    **http-port**

        **Description** Configure the http port to use(default 80) (http port(default 80))

        **Type:** number

        **Range:** 1-65535

        **Default:** 80

    **http-protocol**

        **Description** 'http': Use http protocol; 'https': Use https protocol(default);  (http protocol)

        **Type:** string

        **Supported Values:** http, https

        **Default:** https

    **https-port**

        **Description** Configure the https port to use(default 443) (https port(default 443))

        **Type:** number

        **Range:** 1-65535

        **Default:** 443

    **relative-uri**

        **Description** Configure the relative uri for the api(e.g /example , default /) (api relative uri)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Default:** /

    **timeout**

        **Description** Configure the api execution timeout(default 10secs) (api timeout)

        **Type:** number

        **Range:** 5-60

        **Default:** 10

    **use-mgmt-port**

        **Description** Use management port to send out notification

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1066_api_authentication:

api_authentication
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **api-key**

        **Description** Configure api-key as a mode of authentication

        **Type:** boolean

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

        **Default:** 0

    **api-key-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **api-key-string**

        **Description** Configure api-key as a mode of authentication

        **Type:** string

        **Format:** password

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **auth-password**

        **Description** Configure the authentication user password (Authentication password)

        **Type:** boolean

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

        **Default:** 0

    **auth-password-val**

        **Description** Configure the authentication user password (Authentication password)

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **auth-username**

        **Description** Configure the authentication user name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **relative-login-uri**

        **Description** Configure the authentication login uri

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **relative-logoff-uri**

        **Description** Configure the authentication logoff uri

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