Get MI Listeners by query

Description

Returns a list of MI Listeners by query (filter).

URL

Copy code
/Admin/rest/v1/milisteners?query={<QUERY_NAME>["<YOUR_QUERY_VALUE>"]}

Remarks

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

MI Listener Query values

QUERY_NAME options

  • Purpose
  • ID
  • Name
  • IP

HTTP method

GET: Returns a list of MI listeners by query.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

VersionCookie
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:

None

Request examples:

Copy code
Request that retrieves ID and Name of an MI Listener that has "Diagnostics" purpose:
GET http://<LRE_Server>/Admin/rest/v1/milisteners?fields=ID,Name&query={Purpose[Diagnostics]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
Request that retrieves ID and Name of an MI Listener that has "Monitoring" purpose:
GET http://<LRE_Server>/Admin/rest/v1/milisteners?fields=ID,Name&query={Purpose[Monitoring]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
Request that retrieves ID and Name of an MI Listener that has a specific IP:
GET http://<LRE_Server>/Admin/rest/v1/milisteners?fields=ID,Name&query={IP['127.0.0.1']}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
Request that retrieves Name of an MI Listener that has a specific ID:
GET http://<LRE_Server>/Admin/rest/v1/milisteners?fields=Name&query={ID['1052']}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
Request that retrieves all MI Listeners that have 'Monitoring' purpose:
GET http://<LRE_Server>/Admin/rest/v1/milisteners?query={Purpose[Monitoring]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

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.

Response examples:

Copy code
XML example:
</MIListeners> 
   <MIListener> 
      <Name>MIL_3</Name>
      <ID>1003</ID>
    </MIListener> 
</MIListeners> 
Copy code
JSON example:
[
    {
        "ID": 1053,
        "Name": "MIL_3",
        "IP": "123.123.123.321",
        "Purposes": [
            "Monitoring"
        ],
        "Comments": null
    }
]

See also: