Get MI Listeners by ID

Description

Returns, updates, or deletes an MI Listener (per the specified MI Listener ID).

• To get MI Listener information, an HTTP request should be sent to the URL returned in the Location header of the response of the MI Listener entity creation (see Manage MI Listeners) or the URL can be composed by concatenating the returned milistenerID to the URL that was used for the MI Listener creation. For existing MI Listeners in LAB_MANAGEMENT project, you can concatenate the value in the “MI Listener ID” field to the URL that was used for the MI Listener creation.
• To delete an MI Listener, an HTTP request should be sent to the URL below.

URL

/Admin/rest/v1/milisteners/{milistenersID}

Remarks

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

HTTP Method

GET: Returns the MI Listener information.

PATCH: Updates the MI Listener.

DELETE: Deletes the MI Listener.

Request

Headers:

One of the following:

• Content-Type: application/xml

• Content-Type: application/json

Cookies:

Request Body:

GET, DELETE: No request body.

PATCH: An XML or JSON describing the data to be updated in the MI Listener.

Request Example - GET

Copy code

XML example:

GET http://<LRE_Server>/Admin/rest/v1/milisteners/1000
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Request Examples - PATCH

Copy code

XML example:

PATCH http://<LRE_Server>/Admin/rest/v1/milisteners/1000
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

<MIListener> 
     <Name>MIL_3</Name>
     <IP>123.123.123.321</IP>  
     <Purposes> 
       <Purpose>Monitoring</Purpose>
     </Purposes> 
 </MIListener> 

Copy code

JSON example:

PATCH http://<LRE_Server>/Admin/rest/v1/milisteners/1000
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};

{
        "Name": "MIL_455555_updated",
        "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 200 (OK).

HTML Body:

DELETE, PATCH: No body returned.

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

Response examples - GET

Copy code

XML example:

<MIListener>
    <ID>1053</ID>
    <Name>MIL_3</Name>
    <IP>123.123.123.321</IP>
    <Purposes>
        <Purpose>Monitoring</Purpose>
    </Purposes>
</MIListener>

Copy code

JSON example:

{
    "ID": 1053,
    "Name": "MIL_3",
    "IP": "123.123.123.321",
    "Purposes": [
        "Monitoring"
    ],
    "Comments": null
}

See Also

Get MI Listeners
Get MI Listeners by Query