.. _file_inspection_global:

file-inspection global
======================

File Inspection global commands


global Specification
--------------------

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

	 **Element Name**                      global

	 **Element URI**                       /axapi/v3/file-inspection/global

	 **Element Attributes**                global_attributes

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



.. raw:: html

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


:ref:`704_global_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/global



.. raw:: html

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


:ref:`704_global_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/file-inspection/global



.. raw:: html

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


:ref:`704_global_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/global



.. raw:: html

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


:ref:`704_global_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/file-inspection/global



.. raw:: html

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


:ref:`704_global_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _704_global_attributes:

global attributes
-----------------

    **classification**

        **Description:** classification is a **JSON Block**.  Please see below for :ref:`704_classification` 

        **Type:** Object

    **logging**

        **Description:** logging is a **JSON Block**.  Please see below for :ref:`704_logging` 

        **Type:** Object

    **max-buffer-size**

        **Description** Maximum size (bytes) of content that can be buffered - default 0 (disabled) (Maximum size (bytes) content that can be buffered - default 0 (disabled))

        **Type:** number

        **Range:** 0-268435455

        **Default:** 0

    **max-concurrent-files**

        **Description** Max concurrenet inspected files per server - default 10 ( Max concurrenet inspected files per server - default 10)

        **Type:** number

        **Range:** 1-100

        **Default:** 10

    **max-concurrent-files-action**

        **Description** 'bypass': Bypass File Inspection (default); 

        **Type:** string

        **Supported Values:** bypass

        **Default:** bypass

    **max-file-size**

        **Description** Maximum file size (bytes) - default 157286400

        **Type:** number

        **Range:** 0-1073741824

        **Default:** 157286400

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _704_logging:

logging
^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bypass**

        **Description:** bypass is a **JSON Block**.  Please see below for :ref:`704_logging_bypass` 

        **Type:** Object

    **failed-transactions**

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

        **Type:** string

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

        **Default:** log

    **local-logging-disable**

        **Description** Disable local logging

        **Type:** boolean

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

        **Default:** 0

.. _704_logging_bypass:

logging_bypass
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **aflex-disabled-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** aflex-disabled-log and all-bypass-log are mutually exclusive

    **all-bypass-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** all-bypass-logno-content-disposition-log, old-http-version-log, aflex-disabled-log, service-disabled-log, service-down-log, max-concurrent-files-log,  filesize-overlimit-log and internal-buffered-overlimit-log are mutually exclusive

    **filesize-overlimit-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** filesize-overlimit-log and all-bypass-log are mutually exclusive

    **internal-buffered-overlimit-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** internal-buffered-overlimit-log and all-bypass-log are mutually exclusive

    **max-concurrent-files-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** max-concurrent-files-log and all-bypass-log are mutually exclusive

    **no-content-disposition-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** no-content-disposition-log and all-bypass-log are mutually exclusive

    **old-http-version-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** old-http-version-log and all-bypass-log are mutually exclusive

    **service-disabled-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** service-disabled-log and all-bypass-log are mutually exclusive

    **service-down-log**

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

        **Type:** string

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

        **Default:** no-log

        **Mutual Exclusion:** service-down-log and all-bypass-log are mutually exclusive

.. _704_classification:

classification
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **classification-disable**

        **Description** Disable Internal File Inspection Classification

        **Type:** boolean

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

        **Default:** 0

    **max-classification-len**

        **Description** maximum length to be taken for file classification - default 65536

        **Type:** number

        **Range:** 1-268435455

        **Default:** 65536

    **min-classification-len**

        **Description** minimum length to be taken for file classification - default 4096

        **Type:** number

        **Range:** 1-268435455

        **Default:** 4096