Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.5.0

Jul 30, 2026

v0.4.0

Jul 29, 2026

Changes in this version

type Client

+ func (c *Client) SetHTTPClient(client *http.Client)

v0.3.0

Jul 28, 2026

v0.2.0

Jul 27, 2026

v0.1.0

Jul 16, 2026

Changes in this version

+ func HasResults(data []byte) (bool, string, int)

+ type BatchStatus struct

+ Progress int

+ Results string

+ Status string

+ type BatchStrategy struct

+ func (s *BatchStrategy) GetEndpoint(baseURL string) string

+ func (s *BatchStrategy) NeedsSessionID() bool

+ func (s *BatchStrategy) PrepareHeaders(opts SendOptions) map[string]string

+ type Client struct

+ func NewClient(apiURL, apiKey string) *Client

+ func NewClientWithMode(apiURL, apiKey string, batchMode bool) *Client

+ func NewClientWithStrategy(apiURL, apiKey string, strategy SendStrategy) *Client

+ func (c *Client) GetBatchResults(sessionID string) (string, string, int, error)

+ func (c *Client) GetBatchStatus(sessionID string) (*BatchStatus, error)

+ func (c *Client) SendBatch(wfpContent string) (string, error)

+ func (c *Client) SendBatchWithContext(wfpContent string, sessionID string, isFinalChunk bool, sbomContext string) (string, error)

+ func (c *Client) SendBatchWithSBOM(wfpContent string, sessionID string, isFinalChunk bool, sbom *SBOMContext) (string, error)

+ func (c *Client) SendBatchWithSession(wfpContent string, sessionID string, isFinalChunk bool) (string, error)

+ func (c *Client) SendFingerprint(fp *models.FileFingerprint) (string, error)

+ func (c *Client) SendFingerprints(wfp string, opts SendOptions) (*SendResponse, error)

+ func (c *Client) SetInsecureTLS(insecure bool)

+ type DirectStrategy struct

+ func (s *DirectStrategy) GetEndpoint(baseURL string) string

+ func (s *DirectStrategy) NeedsSessionID() bool

+ func (s *DirectStrategy) PrepareHeaders(opts SendOptions) map[string]string

+ type SBOMContext struct

+ Assets string

+ Type string

+ type ScanClient interface

+ GetBatchStatus func(sessionID string) (*BatchStatus, error)

+ SendFingerprints func(wfp string, opts SendOptions) (*SendResponse, error)

+ type ScanStatus struct

+ Progress int

+ Started int64

+ Status string

+ type SendOptions struct

+ IsFinalChunk bool

+ Metadata map[string]string

+ SBOMContext string

+ SessionID string

+ type SendResponse struct

+ Data string

+ Immediate bool

+ StatusCode int

+ type SendStrategy interface

+ GetEndpoint func(baseURL string) string

+ NeedsSessionID func() bool

+ PrepareHeaders func(opts SendOptions) map[string]string