Administering

Administration tasks can be completed by system administrators or messaging administrators by using the Amlen WebUI, or by using REST Administration APIs.

Administering by using the web UI

You can connect to the Amlen WebUI by using a web browser. For more information about how you can connect to the Amlen WebUI, see Logging in to the Amlen WebUI

Administering by using REST Administration APIs

Eclipse Amlen has a REST (REpresentational State Transfer) interface and provides REST Administration APIs which you can use to administer and monitor your system.

To run a REST Administration API, call a method on a REST resource and pass parameters or a request in JSON format. The methods that the REST Administration APIs use are POST, GET, and DELETE:
  • The POST method creates or updates a configuration object.
  • The GET method retrieves data about a configuration object.
  • The DELETE method deletes a configuration object.
You can write scripts or use the Linux™ program cURL to run the REST Administration APIs. Combine a REST URI with the REST method to be used and the data to be passed to create the REST request.