# logpoint_api v2.2.0 - Table of Contents

A stateless Elixir wrapper for the Logpoint SIEM API.
Covers searching, incidents, alert rules, user-defined lists, and repos
with builder patterns for rules and notifications.

## Pages

- [LogpointApi](readme.md)
- [Contributing](contributing.md)
- [LICENSE](license.md)

- How-To
  - [Polling for Search Results](polling-search-results.md)

- Upgrading
  - [Upgrading to v2](v2.md)

## Modules

- [LogpointApi](LogpointApi.md): Elixir library for interacting with the Logpoint API.
- [LogpointApi.Core.AlertRule](LogpointApi.Core.AlertRule.md): Manage alert rules and their notifications in Logpoint.
- [LogpointApi.Core.Incident](LogpointApi.Core.Incident.md): Manage incidents in Logpoint.
- [LogpointApi.Core.LogpointRepo](LogpointApi.Core.LogpointRepo.md): List searchable logpoints and their repos.
- [LogpointApi.Core.Search](LogpointApi.Core.Search.md): Search logs and retrieve instance data from Logpoint.
- [LogpointApi.Core.SearchRunner](LogpointApi.Core.SearchRunner.md): Blocking polling for Logpoint searches.
- [LogpointApi.Core.UserDefinedList](LogpointApi.Core.UserDefinedList.md): Manage user-defined lists in Logpoint.
- [LogpointApi.Data.Client](LogpointApi.Data.Client.md): Holds the base URL, credential, and SSL settings for API requests.
- [LogpointApi.Data.Comment](LogpointApi.Data.Comment.md): An incident comment linking a comment string to an incident ID.
- [LogpointApi.Data.Credential](LogpointApi.Data.Credential.md): Username and secret key used to authenticate with the Logpoint API.
- [LogpointApi.Data.EmailNotification](LogpointApi.Data.EmailNotification.md): Builder for email notification structs.
- [LogpointApi.Data.HttpNotification](LogpointApi.Data.HttpNotification.md): Builder for HTTP notification structs.
- [LogpointApi.Data.Rule](LogpointApi.Data.Rule.md): Builder for alert rule structs.
- [LogpointApi.Data.SearchParams](LogpointApi.Data.SearchParams.md): Search query parameters passed to `LogpointApi.Core.Search` functions.