api

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) GetEvent(input *models.GetEventInput) (*models.GetEventOutput, error)
  • func (API) ListAlerts(input *models.ListAlertsInput) (result *models.ListAlertsOutput, err error)

Functions

func Setup

func Setup()

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

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) GetEvent

func (API) GetEvent(input *models.GetEventInput) (*models.GetEventOutput, error)

GetEvent retrieves a specific event

func (API) ListAlerts

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

ListAlerts retrieves alert and event details.