.. _slb_common_cert_pinning:

slb common cert-pinning
=======================

Configure the cert-pinning related settings


cert-pinning Specification
--------------------------

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

	===================================== ================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      cert-pinning

	 **Element URI**                       /axapi/v3/slb/common/cert-pinning

	 **Element Attributes**                cert-pinning_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`cert-pinning schema <slb-common-cert-pinning/slb-common-cert-pinning.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/slb/common/cert-pinning



.. raw:: html

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


:ref:`2720_cert-pinning_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/slb_common_cert_pinning_POST.txt
   :literal:




.. raw:: html

   </div></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/slb/common/cert-pinning



.. raw:: html

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


:ref:`2720_cert-pinning_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/slb_common_cert_pinning_GET.txt
   :literal:




.. raw:: html

   </div></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/slb/common/cert-pinning



.. raw:: html

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


:ref:`2720_cert-pinning_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/slb/common/cert-pinning



.. raw:: html

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


:ref:`2720_cert-pinning_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/slb_common_cert_pinning_PUT.txt
   :literal:




.. raw:: html

   </div></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/slb/common/cert-pinning



.. raw:: html

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


:ref:`2720_cert-pinning_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/slb_common_cert_pinning_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2720_cert-pinning_attributes:

cert-pinning attributes
-----------------------

    **candidate-list-feedback-opt-in**

        **Description:** candidate-list-feedback-opt-in is a **JSON Block**.  Please see below for :ref:`2720_candidate-list-feedback-opt-in` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/slb/common/cert-pinning/candidate-list-feedback-opt-in <slb_common_cert_pinning_candidate_list_feedback_opt_in>`

    **ttl**

        **Description** The ttl of local cert pinning candidate list, multiple of 10 minutes, default is 144 (1440 minutes)

        **Type:** number

        **Range:** 1-1008

        **Default:** 144

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2720_candidate-list-feedback-opt-in:

candidate-list-feedback-opt-in
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

    **enable**

        **Description** Enable the feedback function

        **Type:** boolean

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

        **Default:** 0

    **schedule**

        **Description** schedule the uploading time, default is daily 00:00

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port to connect

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