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
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.3.2

Dec 15, 2025

v0.3.1

Jul 4, 2025

v0.3.0

Nov 14, 2023

Changes in this version

type Client

+ HTTPClient *http.Client

type UserInfo

+ APIHosts map[string]string

v0.2.0

Mar 10, 2023

v0.1.0

Sep 4, 2020

Changes in this version

+ const DefaultTimeout

+ func NewLoggingHTTPClient() *http.Client

+ type AgentRealtimeInfo struct

+ AccountID string

+ AccountName string

+ AgentComputerName string

+ AgentDomain string

+ GroupID string

+ GroupName string

+ SiteID string

+ SiteName string

+ type Client struct

+ AuthConfig *clientcredentials.Config

+ AuthToken string

+ HttpClient *http.Client

+ ManagementURL string

+ func NewClient(url, token string) (c *Client)

+ func (c *Client) CheckViewer() (ok bool, err error)

+ func (c *Client) Do(req *http.Request) (res *http.Response, err error)

+ func (c *Client) GetJSONItems(request *http.Request) (items []json.RawMessage, err error)

+ func (c *Client) GetJSONResponse(req *http.Request) (data *ResponseBody, err error)

+ func (c *Client) GetSites(values url.Values) (data []*Site, err error)

+ func (c *Client) GetThreats(values url.Values) (threats []*Threat, err error)

+ func (c *Client) NewRequest(method, url string, body io.Reader) (req *http.Request, err error)

+ type JSONError struct

+ Code int

+ Detail string

+ Title string

+ type JSONErrorObject struct

+ Errors []JSONError

+ type LoggingRoundTripper struct

+ Base http.RoundTripper

+ func (r LoggingRoundTripper) RoundTrip(req *http.Request) (res *http.Response, err error)

+ type Pagination struct

+ NextCursor string

+ TotalItems int

+ type ResponseBody struct

+ Data json.RawMessage

+ Error *JSONErrorObject

+ Errors []JSONError

+ Message string

+ Name string

+ Pagination *Pagination

+ type Site struct

+ ID string

+ Name string

+ SiteType string

+ type SiteResult struct

+ AllSites json.RawMessage

+ Sites []*Site

+ type SuccessMessage struct

+ Success bool

+ type Threat struct

+ AgentRealtimeInfo AgentRealtimeInfo

+ ThreatInfo ThreatInfo

+ type ThreatInfo struct

+ AnalystVerdict string

+ AnalystVerdictDescription string

+ Classification string

+ ClassificationSource string

+ CreatedAt time.Time

+ Engines []string

+ IncidentStatus string

+ IncidentStatusDescription string

+ MitigationStatus string

+ MitigationStatusDescription string

+ ThreatName string

+ type UserInfo struct

+ ApiHosts map[string]string

+ ID string

+ IDType string