.. _file_inspection_template:

file-inspection template
========================

Manage File Inspection template configuration


template Specification
----------------------

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

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

	 **Collection Name**                   :ref:`599_template_list`

	 **Collection URI**                    /axapi/v3/file-inspection/template

	                                       

	 **Element Name**                      template

	 **Element URI**                       /axapi/v3/file-inspection/template/{name}

	 **Element Attributes**                template_attributes

	 **Schema**                             :download:`template schema <file-inspection-template/file-inspection-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/file-inspection/template



.. raw:: html

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


:ref:`599_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/file-inspection/template



.. raw:: html

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


:ref:`599_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/file-inspection/template/{name}



.. raw:: html

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


:ref:`599_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/file-inspection/template



.. raw:: html

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


:ref:`599_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/file-inspection/template/{name}



.. raw:: html

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


:ref:`599_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/file-inspection/template/{name}



.. raw:: html

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


:ref:`599_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/file-inspection/template



.. raw:: html

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


:ref:`599_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/file-inspection/template/{name}



.. raw:: html

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


:ref:`599_template_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _599_template_list:

template-list
-------------


    template-list is **JSON List** of :ref:`599_template_attributes` 

        template-list : [

             { :ref:`599_template_attributes` },

             { :ref:`599_template_attributes` },

             ...

         ]

.. _599_template_attributes:

template attributes
-------------------

    **bad-downloads-action**

        **Description** 'reset': Reset Connection; 'drop': Drop File (default); 'allow': Allow File; 

        **Type:** string

        **Supported Values:** reset, drop, allow

        **Default:** drop

    **bad-uploads-action**

        **Description** 'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File; 

        **Type:** string

        **Supported Values:** reset, drop, allow

    **downloads-bad-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

    **downloads-external-inspect**

        **Description** respmod template for external icap inspection

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** downloads-external-inspect and suspect-downloads-action are mutually exclusive

        **Refernce Object:** :doc:`/axapi/v3/slb/template/respmod-icap <slb_template_respmod_icap>`

    **downloads-external-suspect-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

    **downloads-good-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

    **downloads-suspect-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

    **good-downloads-action**

        **Description** 'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File (default); 

        **Type:** string

        **Supported Values:** reset, drop, allow

        **Default:** allow

    **good-uploads-action**

        **Description** 'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File; 

        **Type:** string

        **Supported Values:** reset, drop, allow

    **inspect**

        **Description:** inspect is a **JSON Block**.  Please see below for :ref:`599_inspect` 

        **Type:** Object

    **name**

        **Description** file-inspection template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **suspect-downloads-action**

        **Description** 'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File (default); 

        **Type:** string

        **Supported Values:** reset, drop, allow

        **Default:** allow

        **Mutual Exclusion:** suspect-downloads-action and downloads-external-inspect are mutually exclusive

    **suspect-uploads-action**

        **Description** 'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File; 

        **Type:** string

        **Supported Values:** reset, drop, allow

        **Mutual Exclusion:** suspect-uploads-action and uploads-external-inspect are mutually exclusive

    **uploads-bad-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

    **uploads-external-inspect**

        **Description** reqmod template for external icap inspection

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** uploads-external-inspect and suspect-uploads-action are mutually exclusive

        **Refernce Object:** :doc:`/axapi/v3/slb/template/reqmod-icap <slb_template_reqmod_icap>`

    **uploads-external-suspect-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

    **uploads-good-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

    **uploads-suspect-log**

        **Description** 'log': Log event (default); 'no-log': Do not Log event; 

        **Type:** string

        **Supported Values:** log, no-log

        **Default:** log

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

.. _599_inspect:

inspect
^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **download-icap**

        **Description** respmod icap template (respmod icap Config name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Refernce Object:** :doc:`/axapi/v3/slb/template/respmod-icap <slb_template_respmod_icap>`

    **inspect-downloads**

        **Description** Inspect file downloads

        **Type:** boolean

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

        **Default:** 0