.. _import_periodic_rpz:

import-periodic rpz
===================

Response Policy Zone File


rpz Specification
-----------------

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

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

	 **Object Key(s)**                     *rpz*

	 **Collection Name**                   :ref:`1884_rpz_list`

	 **Collection URI**                    /axapi/v3/import-periodic/rpz

	                                       

	 **Element Name**                      rpz

	 **Element URI**                       /axapi/v3/import-periodic/rpz/{rpz}

	 **Element Attributes**                rpz_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1884_rpz_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/import_periodic_rpz_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/import-periodic/rpz



.. raw:: html

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


:ref:`1884_rpz_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/import-periodic/rpz/{rpz}



.. raw:: html

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


:ref:`1884_rpz_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/import-periodic/rpz



.. raw:: html

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


:ref:`1884_rpz_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/import-periodic/rpz/{rpz}



.. raw:: html

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


:ref:`1884_rpz_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/import-periodic/rpz/{rpz}



.. raw:: html

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


:ref:`1884_rpz_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/import-periodic/rpz



.. raw:: html

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


:ref:`1884_rpz_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/import-periodic/rpz/{rpz}



.. raw:: html

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


:ref:`1884_rpz_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1884_rpz_list:

rpz-list
--------


    rpz-list is **JSON List** of :ref:`1884_rpz_attributes` 

        rpz-list : [

             { :ref:`1884_rpz_attributes` },

             { :ref:`1884_rpz_attributes` },

             ...

         ]

.. _1884_rpz_attributes:

rpz attributes
--------------

    **period**

        **Description** Specify the period in second

        **Type:** number

        **Range:** 60-31536000

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **remote-file-zone-transfer**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

    **rpz**

        **Description** Response Policy Zone File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **zone-transfer**

        **Description** 'zone-transfer': zone-transfer; 

        **Type:** string

        **Supported Values:** zone-transfer