# guardsix v1.2.2 - Table of Contents

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

## Pages

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

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

## Modules

- [Guardsix](Guardsix.md): Elixir library for interacting with the Guardsix API.
- [Guardsix.Auth.SessionProvider](Guardsix.Auth.SessionProvider.md): Establishes an authenticated browser session with a Guardsix instance.
- [Guardsix.Core.AlertRule](Guardsix.Core.AlertRule.md): Manage alert rules and their notifications in Guardsix.
- [Guardsix.Core.GuardsixRepo](Guardsix.Core.GuardsixRepo.md): List searchable repos.
- [Guardsix.Core.Incident](Guardsix.Core.Incident.md): Manage incidents in Guardsix.
- [Guardsix.Core.Search](Guardsix.Core.Search.md): Search logs and retrieve instance data from Guardsix.
- [Guardsix.Core.SearchRunner](Guardsix.Core.SearchRunner.md): Blocking polling for Guardsix searches.
- [Guardsix.Core.UserDefinedList](Guardsix.Core.UserDefinedList.md): Manage user-defined lists in Guardsix.
- [Guardsix.Core.UserDefinedListBySession](Guardsix.Core.UserDefinedListBySession.md): Session-based operations for user-defined lists in Guardsix.
- [Guardsix.Data.Client](Guardsix.Data.Client.md): Holds the base URL, credential, and SSL settings for API requests.
- [Guardsix.Data.Comment](Guardsix.Data.Comment.md): An incident comment linking a comment string to an incident ID.
- [Guardsix.Data.Credential](Guardsix.Data.Credential.md): Username and secret key used to authenticate with the Guardsix API.
- [Guardsix.Data.EmailNotification](Guardsix.Data.EmailNotification.md): Builder for email notification structs.
- [Guardsix.Data.HttpNotification](Guardsix.Data.HttpNotification.md): Builder for HTTP notification structs.
- [Guardsix.Data.Rule](Guardsix.Data.Rule.md): Builder for alert rule structs.
- [Guardsix.Data.SearchParams](Guardsix.Data.SearchParams.md): Search query parameters passed to `Guardsix.Core.Search` functions.
- [Guardsix.Data.Session](Guardsix.Data.Session.md): Holds an authenticated session for UI endpoints that do not support JWT.

