.. _threat_intel_threat_feed:

threat-intel threat-feed
========================

Configure vendor specific module control options


threat-feed Specification
-------------------------

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

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

	 **Object Key(s)**                     *type*

	 **Collection Name**                   :ref:`3497_threat-feed_list`

	 **Collection URI**                    /axapi/v3/threat-intel/threat-feed

	                                       

	 **Element Name**                      threat-feed

	 **Element URI**                       /axapi/v3/threat-intel/threat-feed/{type}

	 **Element Attributes**                threat-feed_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`threat-feed schema <threat-intel-threat-feed/threat-intel-threat-feed.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/threat-intel/threat-feed



.. raw:: html

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


:ref:`3497_threat-feed_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/threat_intel_threat_feed_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/threat-intel/threat-feed



.. raw:: html

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


:ref:`3497_threat-feed_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/threat-intel/threat-feed/{type}



.. raw:: html

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


:ref:`3497_threat-feed_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/threat_intel_threat_feed_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/threat-intel/threat-feed



.. raw:: html

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


:ref:`3497_threat-feed_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/threat-intel/threat-feed/{type}



.. raw:: html

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


:ref:`3497_threat-feed_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/threat-intel/threat-feed/{type}



.. raw:: html

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


:ref:`3497_threat-feed_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/threat_intel_threat_feed_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/threat-intel/threat-feed



.. raw:: html

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


:ref:`3497_threat-feed_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/threat-intel/threat-feed/{type}



.. raw:: html

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


:ref:`3497_threat-feed_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/threat_intel_threat_feed_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3497_threat-feed_list:

threat-feed-list
----------------


    threat-feed-list is **JSON List** of :ref:`3497_threat-feed_attributes` 

        threat-feed-list : [

             { :ref:`3497_threat-feed_attributes` },

             { :ref:`3497_threat-feed_attributes` },

             ...

         ]

.. _3497_threat-feed_attributes:

threat-feed attributes
----------------------

    **domain**

        **Description** Realm for NTLM authentication

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **enable**

        **Description** Enable module

        **Type:** boolean

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

        **Default:** 0

    **encrypted**

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

    **log-level**

        **Description** 'disable': Disable all logging; 'error': Log error events; 'warning': Log warning events and above; 'info': Log info events and above; 'debug': Log debug events and above; 'trace': enable all logs; 

        **Type:** string

        **Supported Values:** disable, error, warning, info, debug, trace

        **Default:** warning

    **port**

        **Description** Port to query server(default 443)

        **Type:** number

        **Range:** 1-65535

        **Default:** 443

    **proxy-auth-type**

        **Description** 'ntlm': NTLM authentication(default); 'basic': Basic authentication; 

        **Type:** string

        **Supported Values:** ntlm, basic

        **Default:** ntlm

    **proxy-host**

        **Description** Proxy server hostname or IP address

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **proxy-password**

        **Description** Password for proxy authentication

        **Type:** boolean

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

        **Default:** 0

    **proxy-port**

        **Description** Port to connect on proxy server

        **Type:** number

        **Range:** 1-65535

    **proxy-username**

        **Description** Username for proxy authentication

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **rtu-update-disable**

        **Description** Disables real time updates(default enable)

        **Type:** boolean

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

        **Default:** 0

    **secret-string**

        **Description** password value

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **server**

        **Description** Server IP or Hostname

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **server-timeout**

        **Description** Server Timeout in seconds (default: 15s)

        **Type:** number

        **Range:** 1-30

        **Default:** 15

    **type**

        **Description** 'webroot': Configure Webroot module options; 

        **Type:** string

        **Supported Values:** webroot

    **update-interval**

        **Description** Interval to check for database or RTU updates(default 120 mins)

        **Type:** number

        **Range:** 10-14400

        **Default:** 120

    **use-mgmt-port**

        **Description** Use management interface for all communication with threat-intel server

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