.. _ng_waf:

ng-waf
======

NGWAF related commands


ng-waf Specification
--------------------

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

	===================================== ===============================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      ng-waf

	 **Element URI**                       /axapi/v3/ng-waf

	 **Element Attributes**                ng-waf_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ng-waf/stats

	 **Operational Data URI**              /axapi/v3/ng-waf/oper

	 **Schema**                             :download:`ng-waf schema <ng-waf/ng-waf.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/ng-waf



.. raw:: html

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


:ref:`2345_ng-waf_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/ng-waf



.. raw:: html

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


:ref:`2345_ng-waf_attributes`



.. 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/ng-waf



.. raw:: html

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


:ref:`2345_ng-waf_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/ng-waf



.. raw:: html

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


:ref:`2345_ng-waf_attributes`



.. 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/ng-waf



.. raw:: html

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


:ref:`2345_ng-waf_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2345_ng-waf_attributes:

ng-waf attributes
-----------------

    **custom-page**

        **Description:** custom-page is a **JSON Block**.  Please see below for :ref:`2345_custom-page` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ng-waf/custom-page <ng_waf_custom_page>`

    **custom-signals**

        **Description:** custom-signals is a **JSON Block**.  Please see below for :ref:`2345_custom-signals` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ng-waf/custom-signals <ng_waf_custom_signals>`

    **stats-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ng-waf/stats/{name} <ng_waf_stats>`

    **status**

        **Description:** status is a **JSON Block**.  Please see below for :ref:`2345_status` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ng-waf/status <ng_waf_status>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2345_stats-list:

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

	 **Block object keys**             

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

    **name**

        **Description** ng-waf 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

.. _2345_status:

status
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2345_custom-signals:

custom-signals
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2345_custom-page:

custom-page
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters