Add MI Listeners

Description

Add an MI Listener.

URL

Copy code
/Admin/rest/v1/milisteners

Remarks

The MI Listener data can be passed as XMLor JSON containing the equivalent data.

To add an MI Listener, you need to send an HTTP request to create an MI Listener resource.

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

HTTP method

POST: Creates the MI Listener.

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:

POST: An XML or JSON describing the MI Listener.

The request must contain the following fields.

ElementDescription
NameThe name of the MI Listener.
IPThe MI Listener IP.
PurposesThe purposes the MI Listener is used for: RunningVusers, Monitoring, Diagnostics.

Request examples:

Copy code
XML example:
POST http://<LRE_Server>/Admin/rest/v1/milisteners
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

<MIListener> 
     <Name>MIL_4</Name>
     <IP>123.123.123.321</IP>  
     <Purposes> 
       <Purpose>Monitoring</Purpose>
       <Purpose>RunningVusers</Purpose>
     </Purposes> 
 </MIListener> 
Copy code
JSOM example:
POST http://<LRE_Server>/Admin/rest/v1/milisteners
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};

{
        "Name": "MIL_45",
        "IP": "123.0.0.1",
        "Purposes": [
                "Monitoring",
                "RunningVusers"
            ]
}

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML return code:

One of the HTTP return codes

Upon successful deletion, returns HTTP status 201 (Created).

HTML body:

POST: Returns XML or JSON of the MI Listener.

Response examples:

Copy code
XML example:
<MIListener> 
     <Name>MIL_4</Name>
     <IP>123.123.123.321</IP>  
     <Purposes> 
       <Purpose>Monitoring</Purpose>
       <Purpose>RunningVusers</Purpose>
     </Purposes> 
     <ID>1004</ID>
 </MIListener> 
Copy code
JSON example:
Response Example JSON:

{    "ID": 1061,
     "Name": "MIL_45",
     "IP": "123.0.0.1",
     "Purposes": [
        "Monitoring",
        "Running Vusers"    
      ],    
     "Comments": null
}

See also: