.. _system_path_oper:

system path oper
================

Operational Status for the object path


path Specification
------------------

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

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

	 **Collection Name**                   :ref:`3342_path_list`

	 **Collection URI**                    /axapi/v3/system/path/{l2hm-path-name}

	                                       

	 **Element Name**                      path

	 **Element URI**                       /axapi/v3/system/path/{l2hm-path-name}/oper

	 **Element Attributes**                path_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`path schema <system-path-oper/system-path-oper.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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3342_path_attributes`



.. raw:: html

   </td><td></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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3342_path_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/system/path/{l2hm-path-name}/oper



.. raw:: html

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


:ref:`3342_path_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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3342_path_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/system/path/{l2hm-path-name}/oper



.. raw:: html

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


:ref:`3342_path_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/system/path/{l2hm-path-name}/oper



.. raw:: html

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


:ref:`3342_path_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/system/path/{l2hm-path-name}



.. raw:: html

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


:ref:`3342_path_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/system/path/{l2hm-path-name}/oper



.. raw:: html

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


:ref:`3342_path_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3342_path_list:

path-list
---------


    path-list is **JSON List** of :ref:`3342_path_attributes` 

        path-list : [

             { :ref:`3342_path_attributes` },

             { :ref:`3342_path_attributes` },

             ...

         ]

.. _3342_path_attributes:

path attributes
---------------

    **l2hm-path-name**

        **Description** Monitor Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Default:** hc-obj

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`3342_oper` 

        **Type:** Object

.. _3342_oper:

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

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

    **path_list**

        **Type:** List

.. _3342_oper_path_list:

oper_path_list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **apps**

        **Description** 

        **Type:** string

    **endpoint_1**

        **Description** 

        **Type:** string

    **endpoint_2**

        **Description** 

        **Type:** string

    **health_check**

        **Description** 

        **Type:** string

    **l2hm_path**

        **Description** 

        **Type:** string

    **path_state**

        **Description** 

        **Type:** string