.. _ssl_key:

ssl key
=======

ssl certificate and key file information and management commands


key Specification
-----------------

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

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

	 **Object Key(s)**                     *name*

	 **Element Name**                      key

	 **Element URI**                       /axapi/v3/ssl/key/{name}

	 **Element Attributes**                key_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`key schema <ssl-key/ssl-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/ssl/key/{name}



.. raw:: html

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


:ref:`2300_key_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2300_key_attributes:

key attributes
--------------

    **name**

        **Description** ssl certificate local file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **private-key**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 2048 characters

        **Maximum Length:** 1 characters