.. _ddos_template_tcp_progression_tracking_mitigation_request_tracking:

ddos template tcp progression-tracking mitigation request-tracking
==================================================================

Configure and enable TCP Progression Tracking Mitigation per Request response


request-tracking Specification
------------------------------

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

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

	 **Element Name**                      request-tracking

	 **Element URI**                       /axapi/v3/ddos/template/tcp/{name}/progression-tracking/mitigation/request-tracking

	 **Element Attributes**                request-tracking_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`request-tracking schema <ddos-template-tcp-progression-tracking-mitigation-request-tracking/ddos-template-tcp-progression-tracking-mitigation-request-tracking.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/template/tcp/{name}/progression-tracking/mitigation/request-tracking



.. raw:: html

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


:ref:`1252_request-tracking_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/ddos_template_tcp_progression_tracking_mitigation_request_tracking_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/ddos/template/tcp/{name}/progression-tracking/mitigation/request-tracking



.. raw:: html

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


:ref:`1252_request-tracking_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/ddos_template_tcp_progression_tracking_mitigation_request_tracking_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/ddos/template/tcp/{name}/progression-tracking/mitigation/request-tracking



.. raw:: html

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


:ref:`1252_request-tracking_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/template/tcp/{name}/progression-tracking/mitigation/request-tracking



.. raw:: html

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


:ref:`1252_request-tracking_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/ddos_template_tcp_progression_tracking_mitigation_request_tracking_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/ddos/template/tcp/{name}/progression-tracking/mitigation/request-tracking



.. raw:: html

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


:ref:`1252_request-tracking_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/ddos_template_tcp_progression_tracking_mitigation_request_tracking_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1252_request-tracking_attributes:

request-tracking attributes
---------------------------

    **first-request-max-time**

        **Description** Set the maximum idle time before the first request (in unit of 100ms)

        **Type:** number

        **Range:** 1-65535

    **progression-tracking-req-action**

        **Description** 'drop': Drop packets for progression tracking violation exceed (Default); 'blacklist-src': Blacklist-src for progression tracking violation exceed; 

        **Type:** string

        **Supported Values:** drop, blacklist-src

        **Default:** drop

        **Mutual Exclusion:** progression-tracking-req-action and progression-tracking-req-action-list-name are mutually exclusive

    **progression-tracking-req-action-list-name**

        **Description** Configure action-list to take when progression tracking violation exceed

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** progression-tracking-req-action-list-name and progression-tracking-req-action are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/ddos/action-list <ddos_action_list>`

    **progression-tracking-req-enabled**

        **Description** 'enable-check': Enable General Progression Tracking per Request Response; 

        **Type:** string

        **Supported Values:** enable-check

        **Default:** enable-check

    **request-length-max**

        **Description** Set the maximum request length

        **Type:** number

        **Range:** 1-65535

    **request-length-min**

        **Description** Set the minimum request length

        **Type:** number

        **Range:** 1-65535

    **request-response-model**

        **Description** 'enable': Enable Request Response Model; 'disable': Disable Request Response Model; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **request-to-response-max-time**

        **Description** Set the maximum request to response time (in unit of 100ms)

        **Type:** number

        **Range:** 1-65535

    **response-length-max**

        **Description** Set the maximum response length

        **Type:** number

        **Range:** 1-4294967295

    **response-length-min**

        **Description** Set the minimum response length

        **Type:** number

        **Range:** 1-65535

    **response-to-request-max-time**

        **Description** Set the maximum response to request time (in unit of 100ms)

        **Type:** number

        **Range:** 1-65535

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **violation**

        **Description** Set the violation threshold

        **Type:** number

        **Range:** 1-255