.. _ddos_outbound_policy:

ddos outbound-policy
====================

Configure outbound policy


outbound-policy Specification
-----------------------------

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

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

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

	 **Collection Name**                   :ref:`1115_outbound-policy_list`

	 **Collection URI**                    /axapi/v3/ddos/outbound-policy

	                                       

	 **Element Name**                      outbound-policy

	 **Element URI**                       /axapi/v3/ddos/outbound-policy/{name}

	 **Element Attributes**                outbound-policy_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`outbound-policy schema <ddos-outbound-policy/ddos-outbound-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/ddos/outbound-policy



.. raw:: html

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


:ref:`1115_outbound-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/ddos/outbound-policy



.. raw:: html

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


:ref:`1115_outbound-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/ddos/outbound-policy/{name}



.. raw:: html

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


:ref:`1115_outbound-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/ddos/outbound-policy



.. raw:: html

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


:ref:`1115_outbound-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/ddos/outbound-policy/{name}



.. raw:: html

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


:ref:`1115_outbound-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/ddos/outbound-policy/{name}



.. raw:: html

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


:ref:`1115_outbound-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/ddos/outbound-policy



.. raw:: html

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


:ref:`1115_outbound-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/ddos/outbound-policy/{name}



.. raw:: html

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


:ref:`1115_outbound-policy_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1115_outbound-policy_list:

outbound-policy-list
--------------------


    outbound-policy-list is **JSON List** of :ref:`1115_outbound-policy_attributes` 

        outbound-policy-list : [

             { :ref:`1115_outbound-policy_attributes` },

             { :ref:`1115_outbound-policy_attributes` },

             ...

         ]

.. _1115_outbound-policy_attributes:

outbound-policy attributes
--------------------------

    **asn-based-tracking**

        **Description:** asn-based-tracking is a **JSON Block**.  Please see below for :ref:`1115_asn-based-tracking` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/outbound-policy/{name}/asn-based-tracking <ddos_outbound_policy>`

    **country-based-tracking**

        **Description:** country-based-tracking is a **JSON Block**.  Please see below for :ref:`1115_country-based-tracking` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/outbound-policy/{name}/country-based-tracking <ddos_outbound_policy>`

    **name**

        **Description** Specify name of the policy

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **policy-class-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/outbound-policy/{name}/policy-class-list/{class-list-name} <ddos_outbound_policy>`

    **policy-default-class-list**

        **Description:** policy-default-class-list is a **JSON Block**.  Please see below for :ref:`1115_policy-default-class-list` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/outbound-policy/{name}/policy-default-class-list <ddos_outbound_policy>`

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

.. _1115_country-based-tracking:

country-based-tracking
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **configuration**

        **Description** 'configuration': Configure country based tracking; 

        **Type:** string

        **Supported Values:** configuration

    **packet-rate-triggered**

        **Description** Triggered by 1/2 packet rate limitation in per-country-glid.

        **Type:** boolean

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

        **Default:** 0

    **per-country-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>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1115_policy-default-class-list:

policy-default-class-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **class-list-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>`

    **configuration**

        **Description** Default class-list configuration

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1115_asn-based-tracking:

asn-based-tracking
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **configuration**

        **Description** 'configuration': Configure asn based tracking; 

        **Type:** string

        **Supported Values:** configuration

    **packet-rate-triggered**

        **Description** Triggered by 1/2 packet rate limitation in per-asn-glid.

        **Type:** boolean

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

        **Default:** 0

    **per-asn-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>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1115_policy-class-list-list:

policy-class-list-list
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **class-list-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>`

    **class-list-name**

        **Description** Class-list name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/class-list <class_list>`

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