.. _pki:

pki
===

PKI Commands


pki Specification
-----------------

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

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

	 **Element Name**                      pki

	 **Element URI**                       /axapi/v3/pki

	 **Element Attributes**                pki_attributes

	 **Partition Visibility**              None

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



.. raw:: html

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


pki_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _998_pki_attributes:

pki attributes
--------------

    **copy-cert**

        **Description:** copy-cert is a **JSON Block**.  Please see below for :ref:`998_copy-cert` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/pki/copy-cert <pki_copy_cert>`

    **copy-key**

        **Description:** copy-key is a **JSON Block**.  Please see below for :ref:`998_copy-key` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/pki/copy-key <pki_copy_key>`

    **create-oper**

        **Description:** create-oper is a **JSON Block**.  Please see below for :ref:`998_create-oper` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/pki/create-oper <pki_create_oper>`

    **delete**

        **Description:** delete is a **JSON Block**.  Please see below for :ref:`998_delete` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/pki/delete <pki_delete>`

    **delete-oper**

        **Description:** delete-oper is a **JSON Block**.  Please see below for :ref:`998_delete-oper` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/pki/delete-oper <pki_delete_oper>`

    **ssl-ca-cert**

        **Description:** ssl-ca-cert is a **JSON Block**.  Please see below for :ref:`998_ssl-ca-cert` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/pki/ssl-ca-cert <pki_ssl_ca_cert>`

    **ssl-cert**

        **Description:** ssl-cert is a **JSON Block**.  Please see below for :ref:`998_ssl-cert` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/pki/ssl-cert <pki_ssl_cert>`

.. _998_delete-oper:

delete-oper
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **filename**

        **Description** 

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

.. _998_copy-key:

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

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

    **dest-key**

        **Description** Destination key file

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **overwrite**

        **Description** Overwrite the destination file if already present

        **Type:** boolean

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

        **Default:** 0

    **rotation**

        **Description** Specify rotation number of SCEP generated key file

        **Type:** number

        **Range:** 1-4

    **src-key**

        **Description** Source key file

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _998_copy-cert:

copy-cert
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dest-cert**

        **Description** Destination certificate file

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **overwrite**

        **Description** Overwrite the destination file if already present

        **Type:** boolean

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

        **Default:** 0

    **rotation**

        **Description** Specify rotation number of SCEP generated certificate file

        **Type:** number

        **Range:** 1-4

    **src-cert**

        **Description** Source certificate file

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _998_ssl-ca-cert:

ssl-ca-cert
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _998_create-oper:

create-oper
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **bits**

        **Description** '1024': 1024; '2048': 2048; '4096': 4096; 

        **Type:** string

        **Supported Values:** 1024, 2048, 4096

        **Default:** 1024

    **common-name**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **country**

        **Description** 

        **Type:** string

        **Maximum Length:** 3 characters

        **Maximum Length:** 2 characters

    **csr-generate**

        **Description** 

        **Type:** boolean

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

        **Default:** 0

    **division**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **email**

        **Description** 

        **Type:** string

        **Format:** email-addr

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **filename**

        **Description** 

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **locality**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **organization**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **state-province**

        **Description** 

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **valid-days**

        **Description** 

        **Type:** number

        **Range:** 30-3650

        **Default:** 730

.. _998_ssl-cert:

ssl-cert
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _998_delete:

delete
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ca**

        **Description** CA certificate file name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **cert-name**

        **Description** Certificate file name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **crl**

        **Description** CRL file name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **private-key**

        **Description** Private key file name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters