apiserver

Documentation

Index

• Variables
• func CustomRecoveryWithWriter() gin.HandlerFunc
• func NewAPIC(config *csconfig.OnlineApiClientCfg, dbClient *database.Client, ...) (*apic, error)
• type APIServer
  • func NewServer(config *csconfig.LocalApiServerCfg) (*APIServer, error)
  • func (s *APIServer) AttachPluginBroker(broker *csplugin.PluginBroker)
  • func (s *APIServer) Close()
  • func (s *APIServer) GetTLSConfig() (*tls.Config, error)
  • func (s *APIServer) InitController() error
  • func (s *APIServer) Router() (*gin.Engine, error)
  • func (s *APIServer) Run(apiReady chan bool) error
  • func (s *APIServer) Shutdown() error

Variables

var SCOPE_CAPI string = "CAPI"

var SCOPE_CAPI_ALIAS string = "crowdsecurity/community-blocklist" //we don't use "CAPI" directly, to make it less confusing for the user

var SCOPE_LISTS string = "lists"

Functions

func CustomRecoveryWithWriter

func CustomRecoveryWithWriter() gin.HandlerFunc

RecoveryWithWriter returns a middleware for a given writer that recovers from any panics and writes a 500 if there was one.

func NewAPIC

func NewAPIC(config *csconfig.OnlineApiClientCfg, dbClient *database.Client, consoleConfig *csconfig.ConsoleConfig) (*apic, error)

Types

type APIServer

type APIServer struct {
	URL string
	TLS *csconfig.TLSCfg
	// contains filtered or unexported fields
}

func NewServer

func NewServer(config *csconfig.LocalApiServerCfg) (*APIServer, error)

func (*APIServer) AttachPluginBroker

func (s *APIServer) AttachPluginBroker(broker *csplugin.PluginBroker)

func (*APIServer) Close

func (s *APIServer) Close()

func (*APIServer) GetTLSConfig

func (s *APIServer) GetTLSConfig() (*tls.Config, error)

func (*APIServer) InitController

func (s *APIServer) InitController() error

func (*APIServer) Router

func (s *APIServer) Router() (*gin.Engine, error)

func (*APIServer) Run

func (s *APIServer) Run(apiReady chan bool) error

func (*APIServer) Shutdown

func (s *APIServer) Shutdown() error