.. _web_category_reputation_scope:

web-category reputation-scope
=============================

Configure the scope of reputation score


reputation-scope Specification
------------------------------

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

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

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

	 **Collection Name**                   :ref:`4153_reputation-scope_list`

	 **Collection URI**                    /axapi/v3/web-category/reputation-scope

	                                       

	 **Element Name**                      reputation-scope

	 **Element URI**                       /axapi/v3/web-category/reputation-scope/{name}

	 **Element Attributes**                reputation-scope_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/web-category/reputation-scope/{name}/stats

	 **Schema**                             :download:`reputation-scope schema <web-category-reputation-scope/web-category-reputation-scope.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/web-category/reputation-scope



.. raw:: html

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


:ref:`4153_reputation-scope_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/web_category_reputation_scope_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/web-category/reputation-scope



.. raw:: html

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


:ref:`4153_reputation-scope_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/web-category/reputation-scope/{name}



.. raw:: html

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


:ref:`4153_reputation-scope_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/web_category_reputation_scope_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/web-category/reputation-scope



.. raw:: html

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


:ref:`4153_reputation-scope_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/web-category/reputation-scope/{name}



.. raw:: html

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


:ref:`4153_reputation-scope_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/web-category/reputation-scope/{name}



.. raw:: html

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


:ref:`4153_reputation-scope_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/web_category_reputation_scope_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/web-category/reputation-scope



.. raw:: html

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


:ref:`4153_reputation-scope_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/web-category/reputation-scope/{name}



.. raw:: html

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


:ref:`4153_reputation-scope_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/web_category_reputation_scope_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4153_reputation-scope_list:

reputation-scope-list
---------------------


    reputation-scope-list is **JSON List** of :ref:`4153_reputation-scope_attributes` 

        reputation-scope-list : [

             { :ref:`4153_reputation-scope_attributes` },

             { :ref:`4153_reputation-scope_attributes` },

             ...

         ]

.. _4153_reputation-scope_attributes:

reputation-scope attributes
---------------------------

    **greater-than**

        **Description:** greater-than is a **JSON Block**.  Please see below for :ref:`4153_greater-than` 

        **Type:** Object

    **less-than**

        **Description:** less-than is a **JSON Block**.  Please see below for :ref:`4153_less-than` 

        **Type:** Object

    **name**

        **Description** Reputation Scope name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

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

.. _4153_less-than:

less-than
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **less-low-risk**

        **Description** Reputation score is less than or equal to 80

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** less-low-risk,less-trustworthy, less-moderate-risk, less-suspicious,  less-malicious, and less-threshold are mutually exclusive

    **less-malicious**

        **Description** Reputation score is less than or equal to 20

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** less-malicious,less-trustworthy, less-low-risk, less-moderate-risk,  less-suspicious, and less-threshold are mutually exclusive

    **less-moderate-risk**

        **Description** Reputation score is less than or equal to 60

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** less-moderate-risk,less-trustworthy, less-low-risk, less-suspicious,  less-malicious, and less-threshold are mutually exclusive

    **less-suspicious**

        **Description** Reputation score is less than or equal to 40

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** less-suspicious,less-trustworthy, less-low-risk, less-moderate-risk,  less-malicious, and less-threshold are mutually exclusive

    **less-threshold**

        **Description** Reputation score is less than or equal to a customized value (1-100)

        **Type:** number

        **Range:** 1-100

        **Mutual Exclusion:** less-threshold,less-trustworthy, less-low-risk, less-moderate-risk,  less-suspicious, and less-malicious are mutually exclusive

    **less-trustworthy**

        **Description** Reputation score is less than or equal to 100

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** less-trustworthy,less-low-risk, less-moderate-risk, less-suspicious,  less-malicious, and less-threshold are mutually exclusive

.. _4153_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'trustworthy': Trustworthy level(81-100); 'low-risk': Low-risk level(61-80); 'moderate-risk': Moderate-risk level(41-60); 'suspicious': Suspicious level(21-40); 'malicious': Malicious level(1-20); 

        **Type:** string

        **Supported Values:** all, trustworthy, low-risk, moderate-risk, suspicious, malicious

.. _4153_greater-than:

greater-than
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **greater-low-risk**

        **Description** Reputation score is greater than or equal to 61

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** greater-low-risk,greater-trustworthy, greater-moderate-risk, greater-suspicious,  greater-malicious, and greater-threshold are mutually exclusive

    **greater-malicious**

        **Description** Reputation score is greater than or equal to 1

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** greater-malicious,greater-trustworthy, greater-low-risk, greater-moderate-risk,  greater-suspicious, and greater-threshold are mutually exclusive

    **greater-moderate-risk**

        **Description** Reputation score is greater than or equal to 41

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** greater-moderate-risk,greater-trustworthy, greater-low-risk, greater-suspicious,  greater-malicious, and greater-threshold are mutually exclusive

    **greater-suspicious**

        **Description** Reputation score is greater than or equal to 21

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** greater-suspicious,greater-trustworthy, greater-low-risk, greater-moderate-risk,  greater-malicious, and greater-threshold are mutually exclusive

    **greater-threshold**

        **Description** Reputation score is greater than or equal to the customized score (1-100)

        **Type:** number

        **Range:** 1-100

        **Mutual Exclusion:** greater-threshold,greater-trustworthy, greater-low-risk, greater-moderate-risk,  greater-suspicious, and greater-malicious are mutually exclusive

    **greater-trustworthy**

        **Description** Reputation score is greater than or equal to 81

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** greater-trustworthy,greater-low-risk, greater-moderate-risk, greater-suspicious,  greater-malicious, and greater-threshold are mutually exclusive