.. _export_periodic:

export-periodic
===============

Put files to remote site periodically


export-periodic Specification
-----------------------------

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

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

	 **Object Key(s)**                     *class-list*

	 **Collection Name**                   :ref:`795_export-periodic_list`

	 **Collection URI**                    /axapi/v3/export-periodic

	                                       

	 **Element Name**                      export-periodic

	 **Element URI**                       /axapi/v3/export-periodic/{class-list}

	 **Element Attributes**                export-periodic_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`export-periodic schema <export-periodic/export-periodic.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/export-periodic



.. raw:: html

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


:ref:`795_export-periodic_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/export-periodic



.. raw:: html

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


:ref:`795_export-periodic_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/export-periodic/{class-list}



.. raw:: html

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


:ref:`795_export-periodic_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/export-periodic



.. raw:: html

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


:ref:`795_export-periodic_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/export-periodic/{class-list}



.. raw:: html

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


:ref:`795_export-periodic_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/export-periodic/{class-list}



.. raw:: html

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


:ref:`795_export-periodic_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/export-periodic



.. raw:: html

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


:ref:`795_export-periodic_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/export-periodic/{class-list}



.. raw:: html

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


:ref:`795_export-periodic_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _795_export-periodic_list:

export-periodic-list
--------------------


    export-periodic-list is **JSON List** of :ref:`795_export-periodic_attributes` 

        export-periodic-list : [

             { :ref:`795_export-periodic_attributes` },

             { :ref:`795_export-periodic_attributes` },

             ...

         ]

.. _795_export-periodic_attributes:

export-periodic attributes
--------------------------

    **class-list**

        **Description** Class List Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **class-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/export-periodic/{class-list}/class-list/{class-list} <export_periodic>`

    **domain-list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/export-periodic/{class-list}/domain-list/{domain-list} <export_periodic>`

    **geo-location-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/export-periodic/{class-list}/geo-location/{geo-location} <export_periodic>`

    **period**

        **Description** Specify the period in second

        **Type:** number

        **Range:** 60-31536000

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **use-mgmt-port**

        **Description** Use management port as source port

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

.. _795_domain-list-list:

domain-list-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **domain-list**

        **Description** Domain List File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **period**

        **Description** Specify the period in second

        **Type:** number

        **Range:** 60-31536000

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **use-mgmt-port**

        **Description** Use management port as source port

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

.. _795_geo-location-list:

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

	 **Block object keys**             

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

    **geo-location**

        **Description** Geo-location CSV File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **period**

        **Description** Specify the period in second

        **Type:** number

        **Range:** 60-31536000

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **use-mgmt-port**

        **Description** Use management port as source port

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

.. _795_class-list-list:

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

	 **Block object keys**             

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

    **class-list**

        **Description** Class List Name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **period**

        **Description** Specify the period in second

        **Type:** number

        **Range:** 60-31536000

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **use-mgmt-port**

        **Description** Use management port as source port

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