api

Documentation

Overview

Package api defines CRUD actions for the Panther alerts database.

Index

• type API
  • func Setup() *API
  • func (api *API) GetAlert(input *models.GetAlertInput) (result *models.GetAlertOutput, err error)
  • func (api *API) ListAlerts(input *models.ListAlertsInput) (result *models.ListAlertsOutput, err error)
  • func (api *API) UpdateAlertDelivery(input *models.UpdateAlertDeliveryInput) (result *models.UpdateAlertDeliveryOutput, err error)
  • func (api *API) UpdateAlertStatus(input *models.UpdateAlertStatusInput) (models.UpdateAlertStatusOutput, error)
• type EventPaginationToken
• type LogTypeToken

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API has all of the handlers as receiver methods.

func Setup

func Setup() *API

Setup - parses the environment and builds the AWS and http clients.

func (*API) GetAlert

func (api *API) GetAlert(input *models.GetAlertInput) (result *models.GetAlertOutput, err error)

GetAlert retrieves details for a given alert

func (*API) ListAlerts

func (api *API) ListAlerts(input *models.ListAlertsInput) (result *models.ListAlertsOutput, err error)

ListAlerts retrieves alert and event details.

func (*API) UpdateAlertDelivery

func (api *API) UpdateAlertDelivery(input *models.UpdateAlertDeliveryInput) (result *models.UpdateAlertDeliveryOutput, err error)

UpdateAlertDelivery modifies an alert's attributes.

func (*API) UpdateAlertStatus

func (api *API) UpdateAlertStatus(input *models.UpdateAlertStatusInput) (models.UpdateAlertStatusOutput, error)

UpdateAlertStatus modifies an alert's attributes.

type EventPaginationToken

type EventPaginationToken struct {
	LogTypeToToken map[string]*LogTypeToken `json:"logTypeToToken"`
}

EventPaginationToken - token used for paginating through the events in an alert

type LogTypeToken

type LogTypeToken struct {
	S3ObjectKey string `json:"s3ObjectKey"`
	EventIndex  int    `json:"eventIndex"`
}

LogTypeToken - token used for paginating in the events of a specific log type