.. _system_threatx:

system threatx
==============

Global ThreatX Configuration


threatx Specification
---------------------

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

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

	 **Element Name**                      threatx

	 **Element URI**                       /axapi/v3/system/threatx

	 **Element Attributes**                threatx_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3573_threatx_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/system/threatx



.. raw:: html

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


:ref:`3573_threatx_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/system/threatx



.. raw:: html

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


:ref:`3573_threatx_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/system/threatx



.. raw:: html

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


:ref:`3573_threatx_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/system/threatx



.. raw:: html

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


:ref:`3573_threatx_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3573_threatx_attributes:

threatx attributes
------------------

    **control-gw-ip**

        **Description** ThreatX Control Gateway IP address

        **Type:** string

        **Format:** ipv4-address

    **customer**

        **Description** Specify customer

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **disable**

        **Description** Diable ThreatX Sensor

        **Type:** boolean

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

        **Default:** 0

    **dummy**

        **Description** Dummy

        **Type:** boolean

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

        **Default:** 0

    **enable**

        **Description** Enable ThreatX Sensor

        **Type:** boolean

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

        **Default:** 0

    **sensor-key**

        **Description** Specify sensor key

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **start**

        **Description** Start ThreatX Sensor

        **Type:** boolean

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

        **Default:** 0

    **stop**

        **Description** Stop ThreatX Sensor

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