Documentation ¶
Overview ¶
Package api defines CRUD actions for the Panther alerts database.
Index ¶
- func Setup()
- type API
- func (API) GetAlert(input *models.GetAlertInput) (result *models.GetAlertOutput, err error)
- func (API) ListAlerts(input *models.ListAlertsInput) (result *models.ListAlertsOutput, err error)
- func (API) UpdateAlertStatus(input *models.UpdateAlertStatusInput) (result *models.UpdateAlertStatusOutput, err error)
- type EventPaginationToken
- type LogTypeToken
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type API ¶
type API struct{}
API has all of the handlers as receiver methods.
func (API) GetAlert ¶
func (API) GetAlert(input *models.GetAlertInput) (result *models.GetAlertOutput, err error)
GetAlert retrieves details for a given alert
func (API) ListAlerts ¶
func (API) ListAlerts(input *models.ListAlertsInput) (result *models.ListAlertsOutput, err error)
ListAlerts retrieves alert and event details.
func (API) UpdateAlertStatus ¶ added in v1.6.0
func (API) UpdateAlertStatus(input *models.UpdateAlertStatusInput) (result *models.UpdateAlertStatusOutput, err error)
UpdateAlertStatus modifies an alert's attributes.
type EventPaginationToken ¶ added in v1.0.0
type EventPaginationToken struct {
LogTypeToToken map[string]*LogTypeToken `json:"logTypeToToken"`
}
EventPaginationToken - token used for paginating through the events in an alert
type LogTypeToken ¶ added in v1.0.0
type LogTypeToken struct { S3ObjectKey string `json:"s3ObjectKey"` EventIndex int `json:"eventIndex"` }
LogTypeToken - token used for paginating in the events of a specific log type
Click to show internal directories.
Click to hide internal directories.