.. _ddos_interface_http_health_check:

ddos interface-http-health-check
================================

Use DST Interface-ip entry as HTTP health-check target


interface-http-health-check Specification
-----------------------------------------

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

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

	 **Element Name**                      interface-http-health-check

	 **Element URI**                       /axapi/v3/ddos/interface-http-health-check

	 **Element Attributes**                interface-http-health-check_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`interface-http-health-check schema <ddos-interface-http-health-check/ddos-interface-http-health-check.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/interface-http-health-check



.. raw:: html

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


:ref:`1064_interface-http-health-check_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_interface_http_health_check_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/interface-http-health-check



.. raw:: html

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


:ref:`1064_interface-http-health-check_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/ddos/interface-http-health-check



.. raw:: html

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


:ref:`1064_interface-http-health-check_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/interface-http-health-check



.. raw:: html

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


:ref:`1064_interface-http-health-check_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/ddos/interface-http-health-check



.. raw:: html

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


:ref:`1064_interface-http-health-check_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1064_interface-http-health-check_attributes:

interface-http-health-check attributes
--------------------------------------

    **challenge-method**

        **Description** 'http-redirect': http-redirect; 'javascript': javascript; 

        **Type:** string

        **Supported Values:** http-redirect, javascript

    **challenge-redirect-code**

        **Description** '302': 302 Found; '307': 307 Temporary Redirect; 

        **Type:** string

        **Supported Values:** 302, 307

        **Default:** 302

    **challenge-uri-encode**

        **Description** Encode the challenge phrase in uri instead of in http cookie. Default encoded in http cookie

        **Type:** boolean

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

        **Default:** 0

    **enable**

        **Description** 'enable': enable; 

        **Type:** string

        **Supported Values:** enable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters