sdk

Documentation

Index

• Constants
• type Client
  • func NewClient(apiToken string, baseURL string) (*Client, error)
  • func (c *Client) ListStudies() ([]StudyResp, error)
• type StudyResp

Constants

const DEFAULT_URL string = "https://us.api.insight.rapid7.com/opendata"

DEFAULT_URL is the default base URL for the OpenData API endpoint

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an API client for Rapid7's Sonar dataset

func NewClient

func NewClient(apiToken string, baseURL string) (*Client, error)

NewClient constructs a new api client

func (*Client) ListStudies

func (c *Client) ListStudies() ([]StudyResp, error)

ListStudies returns an array of available studies

type StudyResp

type StudyResp struct {
	Uniqid              string   `json:"uniqid"`
	Name                string   `json:"name"`
	ShortDesc           string   `json:"short_desc"`
	LongDesc            string   `json:"long_desc"`
	StudyURL            string   `json:"study_url"`
	StudyName           string   `json:"study_name"`
	StudyVenue          string   `json:"study_venue"`
	StudyBibtext        string   `json:"study_bibtext"`
	ContactName         string   `json:"contact_name"`
	ContactEmail        string   `json:"contact_email"`
	OrganizationName    string   `json:"organization_name"`
	OrganizationWebsite string   `json:"organization_website"`
	CreatedAt           string   `json:"created_at"`
	UpdatedAt           string   `json:"updated_at"`
	SonarfileSet        []string `json:"sonarfile_set"`
}

StudyResp is a Rapid7 OpenData API Study JSON response Ref: https://opendata.rapid7.com/apihelp/