.. _automatic_update_config:

automatic-update config
=======================

Configure software update schedule


config Specification
--------------------

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

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

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

	 **Collection Name**                   :ref:`201_config_list`

	 **Collection URI**                    /axapi/v3/automatic-update/config

	                                       

	 **Element Name**                      config

	 **Element URI**                       /axapi/v3/automatic-update/config/{feature-name}

	 **Element Attributes**                config_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`config schema <automatic-update-config/automatic-update-config.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/automatic-update/config



.. raw:: html

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


:ref:`201_config_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/automatic_update_config_POST.txt
   :literal:




.. raw:: html

   </div></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/automatic-update/config



.. raw:: html

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


:ref:`201_config_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/automatic-update/config/{feature-name}



.. raw:: html

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


:ref:`201_config_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/automatic-update/config



.. raw:: html

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


:ref:`201_config_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/automatic-update/config/{feature-name}



.. raw:: html

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


:ref:`201_config_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/automatic-update/config/{feature-name}



.. raw:: html

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


:ref:`201_config_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/automatic-update/config



.. raw:: html

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


:ref:`201_config_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/automatic-update/config/{feature-name}



.. raw:: html

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


:ref:`201_config_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _201_config_list:

config-list
-----------


    config-list is **JSON List** of :ref:`201_config_attributes` 

        config-list : [

             { :ref:`201_config_attributes` },

             { :ref:`201_config_attributes` },

             ...

         ]

.. _201_config_attributes:

config attributes
-----------------

    **daily**

        **Description** Every day

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** daily and weekly are mutually exclusive

    **day-time**

        **Description** Time of day to update (hh:mm) in 24 hour local time

        **Type:** string

        **Format:** time-hhmm

    **debug**

        **Description** Enable libcurl debug option

        **Type:** boolean

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

        **Default:** 0

    **disable-ssl-verify**

        **Description** Disable peer server certificate verification

        **Type:** boolean

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

        **Default:** 0

    **feature-name**

        **Description** 'app-fw': Application Firewall Configuration; 'ca-bundle': CA Certificate Bundle; 'a10-threat-intel': A10 Threat intel class list; 'central-cert-pin-list': Central updated cert pinning list; 

        **Type:** string

        **Supported Values:** app-fw, ca-bundle, a10-threat-intel, central-cert-pin-list

    **schedule**

        **Description** 

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

    **week-day**

        **Description** 'Monday': Monday; 'Tuesday': Tuesday; 'Wednesday': Wednesday; 'Thursday': Thursday; 'Friday': Friday; 'Saturday': Saturday; 'Sunday': Sunday; 

        **Type:** string

        **Supported Values:** Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

    **week-time**

        **Description** Time of day to update (hh:mm) in 24 hour local time

        **Type:** string

        **Format:** time-hhmm

    **weekly**

        **Description** Every week

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** weekly and daily are mutually exclusive