.. _backup_store:

backup store
============

Save backup store information


store Specification
-------------------

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

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

	 **Element Name**                      store

	 **Element URI**                       /axapi/v3/backup/store

	 **Element Attributes**                store_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`221_store_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _221_store_attributes:

store attributes
----------------

    **creat-cfg**

        **Description:** creat-cfg is a **JSON Block**.  Please see below for :ref:`221_creat-cfg` 

        **Type:** Object

    **delete-cfg**

        **Description:** delete-cfg is a **JSON Block**.  Please see below for :ref:`221_delete-cfg` 

        **Type:** Object

.. _221_delete-cfg:

delete-cfg
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delete**

        **Description** Delete store

        **Type:** boolean

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

        **Default:** 0

    **store-name-del**

        **Description** profile name for deleting

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _221_creat-cfg:

creat-cfg
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **create**

        **Description** Create store

        **Type:** boolean

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

        **Default:** 0

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **store-name**

        **Description** profile name to store remote url

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters