The Apama REST API GET methods return information about correlators, sentinel agents and IAFs, and the PUT /logLevel method changes the specified log level. The GET methods also return information on the dashboard data servers and display servers, with the restrictions mentioned below.

This method returns summary information about the component including its name, version, etc. This is analogous to the data that can be retrieved with the Apama engine_management tool, for example, the hostname field is exactly what engine_management --gethostname gives you.

Checks if the component is still running. If the component is running the client receives an empty response. A failure is a timeout waiting for the response.

This method displays the log level of a component.

This methods sets the log level of a component. Not supported for dashboard servers.

Gets the incoming and outgoing messaging connections to the given component, along with the channels subscribed to and whether or not the receivers are slow. For dashboard servers, this is always empty.

This method returns the arguments used when starting the component as a list of name-value pairs.

This method returns a list the environment variables in use as a list of name-value pairs.

Dashboard servers only. This method returns the names and values of the Java system properties of the component.

This method returns the names of the categories for which you can get general information.