Accessing data using Tivoli Enterprise Monitoring Server REST services

Edit online

You can access OMEGAMON data by using HTTP REST calls.

TEMS REST services overview

Tivoli Enterprise Monitoring Server (TEMS) REST services provide access to OMEGAMON data using HTTP REST calls. Using the TEMS REST services, you can retrieve real-time and historical data collected by the monitoring agents, the configurations used for collecting the historical data, select managed system information, and information about situations. You can also perform activities such as starting, stopping, creating, editing, and deleting situations; executing or deleting a Take Action; and deleting a history collection configuration.

Version v1 of TEMS REST services provides endpoints using the GET, POST, PATCH, PUT, and DELETE methods.

Using TEMS REST services, you can integrate OMEGAMON data into your custom applications, including dashboards and automation, or third-party analytical tools (such as Splunk, Elastic, and Grafana).

TEMS REST services are implemented with the OpenAPI Specification 3.0.3.

Implementation details

Review the following implementation details:
  • TEMS REST services are available on the Tivoli Enterprise Monitoring Server on z/OS® only, for both the hub monitoring server and the remote monitoring server.
    Note: TEMS REST services are not available for monitoring servers on distributed platforms.
  • The endpoints are located at the well-known HTTP or HTTPS port for Tivoli® Management Services on z/OS, as defined at your site. No additional installation or configuration is needed to use TEMS REST services.
  • For secure data transmission, TEMS REST services supports HTTPS. It is recommended that you use HTTPS.
  • For authorization and authentication, TEMS REST services provides Basic authentication and bearer (token) security methods. For more information, see Securing TEMS REST services.
    Note: If you use mixed-case passwords or password phrases (passphrases) for authentication, parameter RTE_SECURITY_FOLD_PASSWORD_FLAG must be set to N.

Access verification

To verify that you can access the TEMS REST services at your site and that the services are available, you can use the GET /timenow endpoint, which retrieves the TEMS local time and requires no additional parameters, as follows:
https://host:port/api/v1/timenow
A successful response verifies access.