.. _slb_template_http_policy:

slb template http-policy
========================

http-policy template


http-policy Specification
-------------------------

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

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

	 **Collection Name**                   :ref:`1435_http-policy_list`

	 **Collection URI**                    /axapi/v3/slb/template/http-policy

	                                       

	 **Element Name**                      http-policy

	 **Element URI**                       /axapi/v3/slb/template/http-policy/{name}

	 **Element Attributes**                http-policy_attributes

	 **Schema**                             :download:`http-policy schema <slb-template-http-policy/slb-template-http-policy.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/slb/template/http-policy



.. raw:: html

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


:ref:`1435_http-policy_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/slb/template/http-policy



.. raw:: html

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


:ref:`1435_http-policy_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/slb/template/http-policy/{name}



.. raw:: html

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


:ref:`1435_http-policy_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/slb/template/http-policy



.. raw:: html

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


:ref:`1435_http-policy_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/slb/template/http-policy/{name}



.. raw:: html

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


:ref:`1435_http-policy_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/slb/template/http-policy/{name}



.. raw:: html

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


:ref:`1435_http-policy_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/slb/template/http-policy



.. raw:: html

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


:ref:`1435_http-policy_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/slb/template/http-policy/{name}



.. raw:: html

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


:ref:`1435_http-policy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1435_http-policy_list:

http-policy-list
----------------


    http-policy-list is **JSON List** of :ref:`1435_http-policy_attributes` 

        http-policy-list : [

             { :ref:`1435_http-policy_attributes` },

             { :ref:`1435_http-policy_attributes` },

             ...

         ]

.. _1435_http-policy_attributes:

http-policy attributes
----------------------

    **cookie-name**

        **Description** name of cookie to match (Cookie Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **geo-location-match**

        **Type:** List

    **http-policy-match**

        **Type:** List

    **name**

        **Description** http-policy template name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

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

.. _1435_http-policy-match:

http-policy-match
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **match-string**

        **Description** URL String

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **match-type**

        **Description** 'contains': Select service group if URL string contains another string; 'ends-with': Select service group if URL string ends with another string; 'equals': Select service group if URL string equals another string; 'starts-with': Select service group if URL string starts with another string; 

        **Type:** string

        **Supported Values:** contains, ends-with, equals, starts-with

    **service-group**

        **Description** Service Group to be used (Service Group Name)

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`

    **template**

        **Description** 'waf': waf;  (WAF template to be used)

        **Type:** string

        **Supported Values:** waf

    **template-name**

        **Description** WAF template to be used (Template Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/waf/template <waf_template>`

    **type**

        **Description** 'cookie': cookie value match; 'host': hostname match; 'url': URL match; 

        **Type:** string

        **Supported Values:** cookie, host, url

.. _1435_geo-location-match:

geo-location-match
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **geo-location**

        **Description** Geolocation name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **geo-location-service-group**

        **Description** Service Group to be used (Service Group Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`

    **geo-location-template**

        **Description** 'waf': waf;  (WAF template to be used)

        **Type:** string

        **Supported Values:** waf

    **geo-location-template-name**

        **Description** WAF template to be used (Template Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/waf/template <waf_template>`