.. _system_ip_threat_list:
system ip-threat-list
=====================
Configure System IP Threat List
ip-threat-list Specification
----------------------------
===================================== ==============================================================
**Parameter** **Value**
===================================== ==============================================================
**Type** *Configuration Resource*
**Element Name** ip-threat-list
**Element URI** /axapi/v3/system/ip-threat-list
**Element Attributes** ip-threat-list_attributes
**Partition Visibility** shared
**Statistics Data URI** /axapi/v3/system/ip-threat-list/stats
**Operational Data URI** /axapi/v3/system/ip-threat-list/oper
**Schema** :download:`ip-threat-list schema <system-ip-threat-list/system-ip-threat-list.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/ip-threat-list
.. raw:: html
</td><td valign = 'top'>
:ref:`3301_ip-threat-list_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/system_ip_threat_list_POST.txt
:literal:
.. raw:: html
</div></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/ip-threat-list
.. raw:: html
</td><td valign = 'top'>
:ref:`3301_ip-threat-list_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/system_ip_threat_list_GET.txt
:literal:
.. raw:: html
</div></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/ip-threat-list
.. raw:: html
</td><td valign = 'top'>
:ref:`3301_ip-threat-list_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/ip-threat-list
.. raw:: html
</td><td valign = 'top'>
:ref:`3301_ip-threat-list_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/system_ip_threat_list_PUT.txt
:literal:
.. raw:: html
</div></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/ip-threat-list
.. raw:: html
</td><td valign = 'top'>
:ref:`3301_ip-threat-list_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/system_ip_threat_list_DELETE.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
</table>
.. _3301_ip-threat-list_attributes:
ip-threat-list attributes
-------------------------
**ipv4-dest-list**
**Description:** ipv4-dest-list is a **JSON Block**. Please see below for :ref:`3301_ipv4-dest-list`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/system/ip-threat-list/ipv4-dest-list <system_ip_threat_list_ipv4_dest_list>`
**ipv4-internet-host-list**
**Description:** ipv4-internet-host-list is a **JSON Block**. Please see below for :ref:`3301_ipv4-internet-host-list`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/system/ip-threat-list/ipv4-internet-host-list <system_ip_threat_list_ipv4_internet_host_list>`
**ipv4-source-list**
**Description:** ipv4-source-list is a **JSON Block**. Please see below for :ref:`3301_ipv4-source-list`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/system/ip-threat-list/ipv4-source-list <system_ip_threat_list_ipv4_source_list>`
**ipv6-dest-list**
**Description:** ipv6-dest-list is a **JSON Block**. Please see below for :ref:`3301_ipv6-dest-list`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/system/ip-threat-list/ipv6-dest-list <system_ip_threat_list_ipv6_dest_list>`
**ipv6-internet-host-list**
**Description:** ipv6-internet-host-list is a **JSON Block**. Please see below for :ref:`3301_ipv6-internet-host-list`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/system/ip-threat-list/ipv6-internet-host-list <system_ip_threat_list_ipv6_internet_host_list>`
**ipv6-source-list**
**Description:** ipv6-source-list is a **JSON Block**. Please see below for :ref:`3301_ipv6-source-list`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/system/ip-threat-list/ipv6-source-list <system_ip_threat_list_ipv6_source_list>`
**sampling-enable**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3301_ipv6-internet-host-list:
ipv6-internet-host-list
^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**class-list-cfg**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3301_ipv6-internet-host-list_class-list-cfg:
ipv6-internet-host-list_class-list-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**class-list**
**Description** Bind class-list (class-list name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/class-list <class_list>`
**ip-threat-action-tmpl**
**Description** Bind ip-threat-action Template (ip-threat-action Template number)
**Type:** number
**Range:** 1-8
.. _3301_ipv4-source-list:
ipv4-source-list
^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**class-list-cfg**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3301_ipv4-source-list_class-list-cfg:
ipv4-source-list_class-list-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**class-list**
**Description** Bind class-list (class-list name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/class-list <class_list>`
**ip-threat-action-tmpl**
**Description** Bind ip-threat-action Template (ip-threat-action Template number)
**Type:** number
**Range:** 1-8
.. _3301_ipv4-internet-host-list:
ipv4-internet-host-list
^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**class-list-cfg**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3301_ipv4-internet-host-list_class-list-cfg:
ipv4-internet-host-list_class-list-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**class-list**
**Description** Bind class-list (class-list name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/class-list <class_list>`
**ip-threat-action-tmpl**
**Description** Bind ip-threat-action Template (ip-threat-action Template number)
**Type:** number
**Range:** 1-8
.. _3301_sampling-enable:
sampling-enable
^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**counters1**
**Description** 'all': all; 'packet_hit_count_in_sw': Packet Hit Count in SW; 'packet_hit_count_in_spe': Packet Hit Count in SPE; 'entries_added_in_sw': Entries Added in SW; 'entries_removed_from_sw': Entries Removed from SW; 'entries_added_in_spe': Entries Added in SPE; 'entries_removed_from_spe': Entries Removed from SPE; 'error_out_of_memory': Out of memory Error; 'error_out_of_spe_entries': Out of SPE Entries Error;
**Type:** string
**Supported Values:** all, packet_hit_count_in_sw, packet_hit_count_in_spe, entries_added_in_sw, entries_removed_from_sw, entries_added_in_spe, entries_removed_from_spe, error_out_of_memory, error_out_of_spe_entries
.. _3301_ipv6-dest-list:
ipv6-dest-list
^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**class-list-cfg**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3301_ipv6-dest-list_class-list-cfg:
ipv6-dest-list_class-list-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**class-list**
**Description** Bind class-list (class-list name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/class-list <class_list>`
**ip-threat-action-tmpl**
**Description** Bind ip-threat-action Template (ip-threat-action Template number)
**Type:** number
**Range:** 1-8
.. _3301_ipv4-dest-list:
ipv4-dest-list
^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**class-list-cfg**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3301_ipv4-dest-list_class-list-cfg:
ipv4-dest-list_class-list-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**class-list**
**Description** Bind class-list (class-list name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/class-list <class_list>`
**ip-threat-action-tmpl**
**Description** Bind ip-threat-action Template (ip-threat-action Template number)
**Type:** number
**Range:** 1-8
.. _3301_ipv6-source-list:
ipv6-source-list
^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**class-list-cfg**
**Type:** List
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3301_ipv6-source-list_class-list-cfg:
ipv6-source-list_class-list-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**class-list**
**Description** Bind class-list (class-list name)
**Type:** string
**Format:** string-rlx
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/class-list <class_list>`
**ip-threat-action-tmpl**
**Description** Bind ip-threat-action Template (ip-threat-action Template number)
**Type:** number
**Range:** 1-8