.. _vpn_revocation:

vpn revocation
==============

IPsec VPN revocation settings


revocation Specification
------------------------

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

	===================================== ==============================================================
	 **Type**                              *Collection*

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

	 **Collection Name**                   :ref:`4093_revocation_list`

	 **Collection URI**                    /axapi/v3/vpn/revocation

	                                       

	 **Element Name**                      revocation

	 **Element URI**                       /axapi/v3/vpn/revocation/{name}

	 **Element Attributes**                revocation_attributes

	 **Partition Visibility**              shared

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


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/vpn/revocation



.. raw:: html

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


:ref:`4093_revocation_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/vpn_revocation_POST.txt
   :literal:




.. raw:: html

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


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/vpn/revocation



.. raw:: html

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


:ref:`4093_revocation_attributes`



.. raw:: html

   </td><td></td></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/vpn/revocation/{name}



.. raw:: html

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


:ref:`4093_revocation_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/vpn/revocation



.. raw:: html

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


:ref:`4093_revocation_list`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/vpn/revocation/{name}



.. raw:: html

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


:ref:`4093_revocation_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/vpn/revocation/{name}



.. raw:: html

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


:ref:`4093_revocation_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/vpn/revocation



.. raw:: html

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


:ref:`4093_revocation_list`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/vpn/revocation/{name}



.. raw:: html

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


:ref:`4093_revocation_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _4093_revocation_list:

revocation-list
---------------


    revocation-list is **JSON List** of :ref:`4093_revocation_attributes` 

        revocation-list : [

             { :ref:`4093_revocation_attributes` },

             { :ref:`4093_revocation_attributes` },

             ...

         ]

.. _4093_revocation_attributes:

revocation attributes
---------------------

    **ca**

        **Description** Certificate Authority file name

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **crl**

        **Description:** crl is a **JSON Block**.  Please see below for :ref:`4093_crl` 

        **Type:** Object

    **name**

        **Description** Revocation name

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **ocsp**

        **Description:** ocsp is a **JSON Block**.  Please see below for :ref:`4093_ocsp` 

        **Type:** Object

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _4093_ocsp:

ocsp
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ocsp-pri**

        **Description** Primary OCSP Authentication Server

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ocsp/instance <aam_authentication_server_ocsp_instance>`

    **ocsp-sec**

        **Description** Secondary OCSP Authentication Server

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/server/ocsp/instance <aam_authentication_server_ocsp_instance>`

.. _4093_crl:

crl
^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **crl-pri**

        **Description** Primary CRL URL (http://www.example.com/ocsp) (only .der filetypes)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **crl-sec**

        **Description** Secondary CRL URL (http://www.example.com/ocsp) (only .der filetypes)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters