.. _ssl:

ssl
===

Local file Mangement


ssl Specification
-----------------

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

	===================================== ============================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      ssl

	 **Element URI**                       /axapi/v3/ssl

	 **Element Attributes**                ssl_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ssl



.. raw:: html

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


ssl_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _3131_ssl_attributes:

ssl attributes
--------------

    **certificate**

        **Description:** certificate is a **JSON Block**.  Please see below for :ref:`3131_certificate` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ssl/certificate/{name} <ssl_certificate>`

    **key**

        **Description:** key is a **JSON Block**.  Please see below for :ref:`3131_key` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ssl/key/{name} <ssl_key>`

.. _3131_key:

key
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

.. _3131_certificate:

certificate
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **certificate-type**

        **Description** 'pem': pem; 'der': der; 'pfx': pfx; 'p7b': p7b; 

        **Type:** string

        **Supported Values:** pem, der, pfx, p7b

    **name**

        **Description** ssl certificate local file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **pfx-password**

        **Description** The password for certificate file (pfx type only)

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **public-key**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 2048 characters

        **Maximum Length:** 1 characters