api

Documentation

Index

• func ServeAPI(config Config)
• type Config
• type ProjectScanOptions
• type SocketEndMessage

Functions

func ServeAPI

func ServeAPI(config Config)

ServeAPI serves the analysis service on the specified port

Types

type Config

type Config struct {
	AppName, AppVersion string
	ApiPort             int
	Local               bool //if set, to bind the api to localhost:port (electron) or simply :port (web service) instead
	ServeGitService     bool
	CheckMateDataPath   string
}

type ProjectScanOptions

type ProjectScanOptions struct {
	ProjectID, ScanID   string
	SecretSearchOptions secrets.SecretSearchOptions
}

type SocketEndMessage

type SocketEndMessage struct {
	Message string
}