REST API Reference

You can use the Representational State Transfer (REST) API to develop your own client application.

LogLogic LMI provides REST API that a client application can use to invoke services using simple HTTP methods. Starting from LogLogic LMI 6.1.1, queries via REST API are encrypted.

You can access LogLogic LMI API online documentation using the following URLs:

Category of services Services provided URL for the REST API
Query API
  • Queries
  • Sub queries
  • Quick queries
https://<hostName>:9681/docs

For more information, see REST API for Advanced Search.

Correlation API
  • Correlation instances
  • Alerts
  • Triggers
  • Metrics
https://<hostName>:9682/docs

For more information, see REST API for Correlation Rules, Triggers, and Alerts.

Monitoring console API
  • Default
  • Authentication
  • Domain
  • Alert
  • Agent
  • Invoke and Subscribe
  • Rulebase
  • Schedule
  • Microagent
https://<hostName>:9687/HawkConsole/v1/docs

For more information, see TIBCO Hawk® Concepts Guide.

Note: The URLs include the default ports. If you change the default ports, update the URL accordingly.

To demonstrate the usage of REST API, some sample scripts are provided in the REST/Samples/ directory in the supplemental package. For more information, see the samples.txt file in the supplemental package.

Authentication and Access

LogLogic LMI users who have Admin or Search Archived Data permissions can access REST API. If a user without these permissions tries to access REST API, authentication fails.