.. _web_service_secure:

web-service secure
==================

Web-service secure operation


secure Specification
--------------------

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

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

	 **Element Name**                      secure

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

	 **Element Attributes**                secure_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`4175_secure_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _4175_secure_attributes:

secure attributes
-----------------

    **certificate**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/web-service/secure/certificate <web_service_secure_certificate>`

    **generate**

        **Description:** generate is a **JSON Block**.  Please see below for :ref:`4175_generate` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/web-service/secure/generate <web_service_secure_generate>`

    **private-key**

        **Description:** private-key is a **JSON Block**.  Please see below for :ref:`4175_private-key` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/web-service/secure/private-key <web_service_secure_private_key>`

    **regenerate**

        **Description:** regenerate is a **JSON Block**.  Please see below for :ref:`4175_regenerate` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/web-service/secure/regenerate <web_service_secure_regenerate>`

    **restart**

        **Description** Restart WEB service

        **Type:** boolean

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

        **Default:** 0

    **wipe**

        **Description** Wipe WEB private-key and certificate

        **Type:** boolean

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

        **Default:** 0

.. _4175_certificate:

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

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

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

    **load**

        **Description** Load WEB certificate

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

.. _4175_regenerate:

regenerate
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **country**

        **Description** The country name

        **Type:** string

        **Maximum Length:** 2 characters

        **Maximum Length:** 2 characters

    **domain-name**

        **Description** The domain name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **state**

        **Description** The location

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _4175_generate:

generate
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **country**

        **Description** The country name

        **Type:** string

        **Maximum Length:** 2 characters

        **Maximum Length:** 2 characters

    **domain-name**

        **Description** The domain name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **state**

        **Description** The location

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

.. _4175_private-key:

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

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

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