.. _ddos_src_geo_location:

ddos src geo-location
=====================

Configure Static Geolocation Entry


geo-location Specification
--------------------------

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

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

	 **Object Key(s)**                     *geolocation-name*

	 **Collection Name**                   :ref:`1164_geo-location_list`

	 **Collection URI**                    /axapi/v3/ddos/src/geo-location

	                                       

	 **Element Name**                      geo-location

	 **Element URI**                       /axapi/v3/ddos/src/geo-location/{geolocation-name}

	 **Element Attributes**                geo-location_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/ddos/src/geo-location/{geolocation-name}/oper

	 **Schema**                             :download:`geo-location schema <ddos-src-geo-location/ddos-src-geo-location.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/src/geo-location



.. raw:: html

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


:ref:`1164_geo-location_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/src/geo-location



.. raw:: html

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


:ref:`1164_geo-location_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/src/geo-location/{geolocation-name}



.. raw:: html

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


:ref:`1164_geo-location_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/src/geo-location



.. raw:: html

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


:ref:`1164_geo-location_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/src/geo-location/{geolocation-name}



.. raw:: html

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


:ref:`1164_geo-location_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/src/geo-location/{geolocation-name}



.. raw:: html

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


:ref:`1164_geo-location_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/src/geo-location



.. raw:: html

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


:ref:`1164_geo-location_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/src/geo-location/{geolocation-name}



.. raw:: html

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


:ref:`1164_geo-location_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1164_geo-location_list:

geo-location-list
-----------------


    geo-location-list is **JSON List** of :ref:`1164_geo-location_attributes` 

        geo-location-list : [

             { :ref:`1164_geo-location_attributes` },

             { :ref:`1164_geo-location_attributes` },

             ...

         ]

.. _1164_geo-location_attributes:

geo-location attributes
-----------------------

    **app-type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/src/geo-location/{geolocation-name}/app-type/{protocol} <ddos_src_geo_location>`

    **bypass**

        **Description** Always permit for the Source to bypass all feature & limit checks

        **Type:** boolean

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

        **Default:** 0

    **description**

        **Description** Description for this Geolocation Entry

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **geolocation-name**

        **Description** Geolocation Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 15 characters

        **Maximum Length:** 1 characters

    **glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **l4-type-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/src/geo-location/{geolocation-name}/l4-type/{protocol} <ddos_src_geo_location>`

    **log-periodic**

        **Description** Enable periodic log while event is continuing

        **Type:** boolean

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

        **Default:** 0

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1164_template` 

        **Type:** Object

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

.. _1164_app-type-list:

app-type-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **protocol**

        **Description** 'dns': dns; 'http': http; 'ssl-l4': ssl-l4; 'sip': sip; 

        **Type:** string

        **Supported Values:** dns, http, ssl-l4, sip

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1164_app-type-list_template` 

        **Type:** Object

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

.. _1164_app-type-list_template:

app-type-list_template
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dns**

        **Description** DDOS DNS template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **http**

        **Description** DDOS HTTP template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **sip**

        **Description** DDOS sip template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **ssl-l4**

        **Description** DDOS SSL-L4 template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1164_l4-type-list:

l4-type-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **action**

        **Description** 'permit': Whitelist incoming packets for protocol; 'deny': Blacklist incoming packets for protocol; 

        **Type:** string

        **Supported Values:** permit, deny

    **glid**

        **Description** Global limit ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/glid <glid>`

    **protocol**

        **Description** 'tcp': tcp; 'udp': udp; 'icmp': icmp; 'other': other; 

        **Type:** string

        **Supported Values:** tcp, udp, icmp, other

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`1164_l4-type-list_template` 

        **Type:** Object

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

.. _1164_l4-type-list_template:

l4-type-list_template
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **other**

        **Description** DDOS OTHER template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **tcp**

        **Description** DDOS TCP template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **template-icmp-v4**

        **Description** DDOS ICMP template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **udp**

        **Description** DDOS UDP template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _1164_template:

template
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **logging**

        **Description** DDOS logging template

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters