The LogRhythm Client Console's Alarm API is a REST API that communicates over HTTPS and uses JSON. The API’s available routes and methods are used primarily for retrieving Alarm Details and performing actions on alarms based on Alarm ID.

All API actions are performed on behalf of an API Account that is identified by the API key passed in with each request. 

The LogRhythm Alarm API includes the following endpoints:

  • Get Alarm by Alarm ID

  • Add Alarm Comment

  • Update Alarm Status and RBP

  • Get Alarm History

  • Get Alarms

  • Get Alarm Summary

  • Get Alarm Events

For more information on methods and endpoints, including request and response samples, go to https://<PM IP Address>:8501/lr-alarm-api/docs or http://<localhost>:8505/lr-alarm-api/docs.

The Log Level for the Alarm API is configured in the Configuration Manager.

To utilize the API, users must generate a token in the Client Console. For more information, see Generate a JSON Web Token to Use the Alarm API.

While LogRhythm provides the API and usage instructions and supports the API's continued health, LogRhythm is not responsible for the support or configuration of third-party tools and applications designed to interact with our APIs.