The LogRhythm Web Console's Search API is a REST API that communicates over HTTPS and uses JSON. The API’s available routes and methods are used primarily for searching the Web Indexer for logs and events. Users can submit a request to the search and interface with the data directly, allowing for integration with third-party applications and custom applications designed for specific business needs.
All API actions are performed on behalf of an API Account that is identified by the API key passed in with each request. To see the current list of Web Console's Search APIs, including request and response samples for Search API, go to https://<hostname>:8501/lr-search-api/docs.
To utilize the API, users must:
- Have a working Web Console installation, as the API uses Web Indexer to return results.
- Generate a token in the Client Console. For more information, see Generate a JSON Web Token to Use the Search API.