.. _file_log_backup:

file log-backup
===============

Backup system files


log-backup Specification
------------------------

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

	===================================== ========================================================
	 **Type**                              *operational*

	 **Element Name**                      log-backup

	 **Element URI**                       /axapi/v3/file/log-backup

	 **Element Attributes**                log-backup_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`log-backup schema <file-log-backup/file-log-backup.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'>


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/file/log-backup



.. raw:: html

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


:ref:`1556_log-backup_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1556_log-backup_attributes:

log-backup attributes
---------------------

    **all**

        **Description** all log

        **Type:** boolean

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

        **Default:** 0

    **date**

        **Description** specify number of days

        **Type:** number

        **Range:** 1-31

    **day**

        **Description** Most recent day

        **Type:** boolean

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

        **Default:** 0

    **expedite**

        **Description** Expedite the Backup

        **Type:** boolean

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

        **Default:** 0

    **file-handle**

        **Description** full path of the uploaded file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **month**

        **Description**  Most recent month

        **Type:** boolean

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

        **Default:** 0

    **period**

        **Description** Specify backup period

        **Type:** boolean

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

        **Default:** 0

    **stats-data**

        **Description** Backup web statistical data

        **Type:** boolean

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

        **Default:** 0

    **week**

        **Description** Most recent week

        **Type:** boolean

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

        **Default:** 0