Deleting a protocol plug-in

System administrators can delete a protocol plug-in by using the Eclipse Amlen REST API DELETE method.

  • To delete a protocol plug-in, use the Eclipse Amlen REST API DELETE method with the following Eclipse Amlen configuration URI:

    http://<admin-endpoint-IP:Port>/ima/v1/configuration/Plugin/<NameOfPlugin>

    Where:

    NameOfPlugin
    Specifies the name of the protocol plug-in that you want to delete.
  • Restart the protocol plug-in server for the deletion to take effect. Use the Eclipse Amlen REST API POST method with the following URI:
    http://<admin-endpoint-IP:Port>/ima/v1/service/restart

    Provide object configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:

    
    {    
      "Service": "Plugin"
    }

The following example demonstrates deleting a protocol plug-in named json_msg by using cURL.

curl -X DELETE
    http://127.0.0.1:9089/ima/v1/configuration/Plugin/json_msg

The following example shows an example response to the DELETE method:


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

The following example shows restarting the protocol plug-in server:

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "Service": "Plugin"
        }
 '  \
http://127.0.0.1:9089/ima/v1/service/restart

The following example shows an example response to the POST method to restart the protocol plug-in server:


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