Get MI Listeners

Description

Return a list of MI Listeners.

URL

Copy code
/Admin/rest/v1/milisteners

HTTP Method

GET: Returns a list of MI Listeners.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

Versions 2023 and later

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions 2022 - 2022 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

Versions 2021 - 2021 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

Versions 2020 - 2020 SP3

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions earlier than 2020

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

QCSession={QC_SESSION_COOKIE_VALUE};

Request Body:

GET: No request body.

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

HTML Body:

GET: Returns the data on the entity in the response. The fields in the response are:

FieldTypeDescription
IDIntegerThe ID of the MI Listener.
IPStringThe IP address of the MI Listener.
NameStringThe name of the MI Listener.
CommentsString 
PurposesList 
Purpose 

Diagnostics

Monitoring

RunningVusers

Copy code
XML example:
<MIListeners>
   <MIListener> 
     <Name>None</Name>
     <IP />  
     <Purposes> 
        <Purpose>RunningVusers</Purpose>  
     </Purposes> 
     <ID>1000</ID>
   </MIListener>  
   <MIListener> 
     <Name>MIL_1</Name>
     <IP>mypc.lab.net</IP>
     <Purposes> 
        <Purpose>RunningVusers</Purpose>
        <Purpose>Monitoring</Purpose>
     </Purposes> 
     <ID>1001</ID>
   </MIListener>  
   <MIListener> 
     <Name>MIL_2</Name>
     <IP />  
     <Purposes> 
        <Purpose>RunningVusers</Purpose>
     </Purposes> 
     <ID>1002</ID>
   </MIListener> 
   <MIListener> 
     <Name>MIL_3</Name>
     <IP>test_IP</IP>  
     <Purposes> 
        <Purpose>Diagnostics</Purpose>
        <Purpose>Monitoring</Purpose>
        <Purpose>RunningVusers</Purpose>
     </Purposes> 
     <ID>1003</ID>
   </MIListener> 
 </MIListeners> 
Copy code
JSON example:
[
    {
        "ID": 1000,
        "Name": "None",
        "IP": "",
        "Purposes": [
            "Running Vusers"
        ],
        "Comments": "System created default MI Listener"
    },
    {
        "ID": 1052,
        "Name": "MIL_V1Sde",
        "IP": "127.0.0.1",
        "Purposes": [
            "Running Vusers"
        ],
        "Comments": null
    },
    {
        "ID": 1053,
        "Name": "MIL_rah4Y",
        "IP": "127.0.0.1",
        "Purposes": [
            "Running Vusers"
        ],
        "Comments": null
    },
    {
        "ID": 1054,
        "Name": "MIL_TbTqz",
        "IP": "127.0.0.1",
        "Purposes": [
            "Running Vusers"
        ],
        "Comments": null
    }
]

See Also

Add MI Listeners
Get MI Listeners by ID
Get MI Listeners by Query