Documentation
¶
Overview ¶
Package api defines CRUD actions for Panther alert outputs.
Index ¶
- func AlertOutputToItem(input *models.AlertOutput) (*table.AlertOutputItem, error)
- func ItemToAlertOutput(input *table.AlertOutputItem) (alertOutput *models.AlertOutput, err error)
- type API
- func (API) AddOutput(input *models.AddOutputInput) (*models.AddOutputOutput, error)
- func (API) DeleteOutput(input *models.DeleteOutputInput) error
- func (API) GetOutput(input *models.GetOutputInput) (*models.GetOutputOutput, error)
- func (API) GetOutputs(_ *models.GetOutputsInput) (models.GetOutputsOutput, error)
- func (API) GetOutputsWithSecrets(_ *models.GetOutputsWithSecretsInput) (models.GetOutputsOutput, error)
- func (API) UpdateOutput(input *models.UpdateOutputInput) (*models.UpdateOutputOutput, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AlertOutputToItem ¶
func AlertOutputToItem(input *models.AlertOutput) (*table.AlertOutputItem, error)
AlertOutputToItem converts an AlertOutput to an AlertOutputItem
func ItemToAlertOutput ¶
func ItemToAlertOutput(input *table.AlertOutputItem) (alertOutput *models.AlertOutput, err error)
ItemToAlertOutput converts an AlertOutputItem to an AlertOutput
Types ¶
type API ¶
type API struct{}
The API consists of receiver methods for each of the handlers.
func (API) AddOutput ¶
func (API) AddOutput(input *models.AddOutputInput) (*models.AddOutputOutput, error)
AddOutput encrypts the output configuration and stores it to Dynamo.
func (API) DeleteOutput ¶
func (API) DeleteOutput(input *models.DeleteOutputInput) error
DeleteOutput removes the alert output configuration
func (API) GetOutput ¶
func (API) GetOutput(input *models.GetOutputInput) (*models.GetOutputOutput, error)
GetOutput retrieves a single alert output
func (API) GetOutputs ¶ added in v0.1.1
func (API) GetOutputs(_ *models.GetOutputsInput) (models.GetOutputsOutput, error)
GetOutputs returns all the alert outputs configured for one organization
func (API) GetOutputsWithSecrets ¶ added in v1.5.0
func (API) GetOutputsWithSecrets(_ *models.GetOutputsWithSecretsInput) (models.GetOutputsOutput, error)
GetOutputsWithSecrets returns all the alert outputs configured for one organization without redacting the secrets. This endpoint should only be reachable from internal services.
func (API) UpdateOutput ¶
func (API) UpdateOutput(input *models.UpdateOutputInput) (*models.UpdateOutputOutput, error)
UpdateOutput updates the alert output with the new values
Source Files