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 Alarm Summary
Get Alarm Events
For more information on methods and endpoints, including request and response samples, go to
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 Register Third-Party Applications to Use the API.