.. _ddos_detection_agent_oper:

ddos detection agent oper
=========================

Operational Status for the object agent


agent Specification
-------------------

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

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

	 **Collection Name**                   :ref:`693_agent_list`

	 **Collection URI**                    /axapi/v3/ddos/detection/agent/{agent-name}

	                                       

	 **Element Name**                      agent

	 **Element URI**                       /axapi/v3/ddos/detection/agent/{agent-name}/oper

	 **Element Attributes**                agent_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`agent schema <ddos-detection-agent-oper/ddos-detection-agent-oper.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/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`693_agent_attributes`



.. raw:: html

   </td><td></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/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`693_agent_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/ddos/detection/agent/{agent-name}/oper



.. raw:: html

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


:ref:`693_agent_attributes`



.. raw:: html

   </td><td></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/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`693_agent_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/ddos/detection/agent/{agent-name}/oper



.. raw:: html

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


:ref:`693_agent_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/ddos/detection/agent/{agent-name}/oper



.. raw:: html

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


:ref:`693_agent_attributes`



.. raw:: html

   </td><td></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/ddos/detection/agent/{agent-name}



.. raw:: html

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


:ref:`693_agent_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/ddos/detection/agent/{agent-name}/oper



.. raw:: html

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


:ref:`693_agent_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _693_agent_list:

agent-list
----------


    agent-list is **JSON List** of :ref:`693_agent_attributes` 

        agent-list : [

             { :ref:`693_agent_attributes` },

             { :ref:`693_agent_attributes` },

             ...

         ]

.. _693_agent_attributes:

agent attributes
----------------

    **agent-name**

        **Description** Specify name for the agent

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`693_oper` 

        **Type:** Object

.. _693_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **brand**

        **Description** 

        **Type:** string

    **sampler-list**

        **Type:** List

.. _693_oper_sampler-list:

oper_sampler-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **active-timeout**

        **Description** 

        **Type:** number

    **inactive-timeout**

        **Description** 

        **Type:** number

    **sample-mode**

        **Description** 

        **Type:** number

    **sampler-id**

        **Description** 

        **Type:** number

    **sampling-algorithm**

        **Description** 

        **Type:** number

    **sampling-rate**

        **Description** 

        **Type:** number