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

Changes in this version

type Client

+ HTTPClient *http.Client

type UserInfo

+ APIHosts map[string]string

v0.3.0

Apr 18, 2023

Changes in this version

type Alert

+ func (a *Alert) String() string

type Endpoint

+ func (e *Endpoint) String() string

v0.2.0

Sep 4, 2020

Changes in this version

+ const DefaultPageSize

+ type AlertManagedAgent struct

+ ID string

+ Type string

type Client

+ PageSize uint32

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

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

+ type LoggingRoundTripper struct

+ Base http.RoundTripper

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

v0.1.0

Sep 3, 2020

Changes in this version

+ const AuthTokenURL

+ const DefaultTimeout

+ const DefaultURL

+ type Alert struct

+ Category string

+ Description string

+ GroupKey string

+ ID string

+ ManagedAgent json.RawMessage

+ Product string

+ RaisedAt time.Time

+ Severity string

+ Type string

+ type Client struct

+ AuthConfig *clientcredentials.Config

+ BaseURL string

+ DataURL string

+ HttpClient *http.Client

+ TenantID string

+ UserInfo *UserInfo

+ func NewClient(id, secret string) (c *Client)

+ func (c *Client) GetAlerts() (alerts []*Alert, err error)

+ func (c *Client) GetCommonURL(urlPart string) string

+ func (c *Client) GetEndpoints() (endpoints []*Endpoint, err error)

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

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

+ func (c *Client) WhoAmI() (err error)

+ type Endpoint struct

+ AssignedProducts []json.RawMessage

+ Health EndpointHealth

+ Hostname string

+ ID string

+ Type string

+ type EndpointHealth struct

+ Overall string

+ Services json.RawMessage

+ Threats json.RawMessage

+ type PageInfo struct

+ FromKey string

+ Items int

+ MaxSize int

+ NextKey string

+ Size int

+ Total int

+ type ResponseBody struct

+ Items []json.RawMessage

+ Pages PageInfo

+ type UserInfo struct

+ ApiHosts map[string]string

+ ID string

+ IDType string