Share this page

# Get MI Listeners

## Description

Return a list of MI Listeners.

## URL

Copy code

    /Admin/rest/v1/milisteners

## Remarks

This API should be authorized for the Application, Tenant, and Site Admin permission levels.

## HTTP method

GET: Returns a list of MI Listeners.

## Request

Headers:

One of the following:

- Content-Type: application/xml

- Content-Type: application/json

Cookies:

Version | Cookie
--- | ---
2023, 24.1, and later | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};
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};
2021 - 2021 R2 | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};
2020 - 2020 SP3 | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};
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 response contains the following fields.

Field | Type | Description
--- | --- | ---
ID | Integer | The ID of the MI Listener.
IP | String | The IP address of the MI Listener.
Name | String | The name of the MI Listener.
Comments | String |
Purposes | List |
Purpose |  | Diagnostics Monitoring RunningVusers

Response examples:

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

Tips to improve your search results... OpenText™ Enterprise Performance Engineering Admin API Reference OpenText™ Enterprise Performance Engineering All View Local Help Center View Online Help Center(Undefined variable: _rscC_Basic_Variables.VersionLabel)