Delete MQTTClient

Purpose

Deletes a specified, unconnected MQTT client.

URI

Use the Eclipse Amlen REST API DELETE method with the following Eclipse Amlen service URI:

http://<admin-endpoint-IP:Port>/ima/v1/service/MQTTClient/<clientId>

where
clientID
Specifies the name of the MQTT client that you want to delete.

Usage Notes®

  • The command must be capitalized as shown.
  • This command also deletes any subscriptions associated with the MQTT client.
  • You must have manage authority to remove an MQTT client.

Related Commands

Example

Deletes an MQTT client that is called exampleClient:
curl -X DELETE http://127.0.0.1:9089/ima/v1/service/MQTTClient/exampleClient
Example response to the DELETE method:

{                  
    "Version": "v1",          
    "Code": "CWLNA6011",          
    "Message": "The requested configuration change has completed successfully."        
}