.. _web_service_secure_private_key:

web-service secure private-key
==============================

Web-service secure private-key operation


private-key Specification
-------------------------

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

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

	 **Element Name**                      private-key

	 **Element URI**                       /axapi/v3/web-service/secure/private-key

	 **Element Attributes**                private-key_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`private-key schema <web-service-secure-private-key/web-service-secure-private-key.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/web-service/secure/private-key



.. raw:: html

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


:ref:`4173_private-key_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _4173_private-key_attributes:

private-key attributes
----------------------

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

    **load**

        **Description** Load WEB private-key

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0