Documentation ¶
Index ¶
- Variables
- type API
- func (api *API) CreateTarget(c echo.Context) error
- func (api *API) DeleteTargetTeam(c echo.Context) error
- func (api *API) DeleteTeam(c echo.Context) error
- func (api *API) GetFinding(c echo.Context) error
- func (api *API) GetFindingFromTargetIssueAndResource(c echo.Context) error
- func (api *API) GetFindingMTTR(c echo.Context) error
- func (api *API) GetIssue(c echo.Context) error
- func (api *API) GetIssueMTTR(c echo.Context) error
- func (api *API) GetSource(c echo.Context) error
- func (api *API) GetSourceMTTR(c echo.Context) error
- func (api *API) GetTarget(c echo.Context) error
- func (api *API) GetTargetMTTR(c echo.Context) error
- func (api *API) Healthcheck(c echo.Context) error
- func (api *API) IssuesSummary(c echo.Context) error
- func (api *API) ListFindingEvents(c echo.Context) error
- func (api *API) ListFindingEventsByFinding(c echo.Context) error
- func (api *API) ListFindings(c echo.Context) error
- func (api *API) ListFindingsByIssue(c echo.Context) error
- func (api *API) ListFindingsBySource(c echo.Context) error
- func (api *API) ListFindingsByTarget(c echo.Context) error
- func (api *API) ListIssues(c echo.Context) error
- func (api *API) ListLabels(c echo.Context) error
- func (api *API) ListSources(c echo.Context) error
- func (api *API) ListTargets(c echo.Context) error
- func (api *API) PatchFinding(c echo.Context) error
- func (api *API) StatsAssets(c echo.Context) error
- func (api *API) StatsCurrentExposure(c echo.Context) error
- func (api *API) StatsExposure(c echo.Context) error
- func (api *API) StatsFixedIssues(c echo.Context) error
- func (api *API) StatsIssues(c echo.Context) error
- func (api *API) StatsMTTR(c echo.Context) error
- func (api *API) StatsOpenIssues(c echo.Context) error
- func (api *API) StatsSize(c echo.Context) error
- func (api *API) TargetsSummary(c echo.Context) error
- type Options
- type Pagination
Constants ¶
This section is empty.
Variables ¶
var ( // ErrDateMalformed indicates that the date format does not comply with YYYY-MM-DD. ErrDateMalformed = errors.New("Malformed Date") // ErrPageMalformed indicates that the page requested is not an integer larger than 0. ErrPageMalformed = errors.New("Malformed Page Number") // ErrPageNotFound indicates that the page requested does not exist. ErrPageNotFound = errors.New("Page Not Found") // ErrSizeMalformed indicates that the size requested is not an integer larger than 0. ErrSizeMalformed = errors.New("Malformed Size Number") // ErrSizeTooLarge indicates that the size requested is larger than the maximum allowed. ErrSizeTooLarge = errors.New("Size Number Too Large") // ErrInvalidFilter indicates that there is a conflict between specified params for the filter. ErrInvalidFilter = errors.New("Filter parameters combination is invalid") )
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct { Options Options // contains filtered or unexported fields }
API holds the storage interface and related methods.
func (*API) CreateTarget ¶
CreateTarget creates a new target or, if the target already exists, associates the given teams to it.
func (*API) DeleteTargetTeam ¶ added in v1.1.0
DeleteTargetTeam deletes the association between a target and a team.
func (*API) DeleteTeam ¶ added in v1.1.0
DeleteTeam deletes all target associations for a team.
func (*API) GetFinding ¶
GetFinding returns a JSON containing a specific finding.
func (*API) GetFindingFromTargetIssueAndResource ¶
GetFindingFromTargetIssueAndResource returns a JSON containing a specific finding which is associated to the specified target ID, issue ID and affected resource. NOTE: this endpoint will work only in a few cases because the affected resource is an arbitrary string, not an ID.
func (*API) GetFindingMTTR ¶
GetFindingMTTR returns a JSON containing the mean time to remediate a finding.
func (*API) GetIssueMTTR ¶
GetIssueMTTR returns a JSON containing the mean time to remediate an issue.
func (*API) GetSourceMTTR ¶
GetSourceMTTR returns the mean time to remediation for a specific source.
func (*API) GetTargetMTTR ¶
GetTargetMTTR returns a JSON containing the mean time to remediate findings in a target.
func (*API) Healthcheck ¶
Healthcheck performs a simple query and returns an OK response.
func (*API) IssuesSummary ¶
IssuesSummary returns a summary of affected assets by issue.
func (*API) ListFindingEvents ¶
ListFindingEvents returns a paginated JSON containing finding events.
func (*API) ListFindingEventsByFinding ¶
ListFindingEventsByFinding returns a paginated JSON containing finding events for a specific finding.
func (*API) ListFindings ¶
ListFindings returns a paginated JSON containing findings.
func (*API) ListFindingsByIssue ¶
ListFindingsByIssue returns a paginated JSON containing findings for a specific issue.
func (*API) ListFindingsBySource ¶
ListFindingsBySource returns a paginated JSON containing findings for a specific source.
func (*API) ListFindingsByTarget ¶
ListFindingsByTarget returns a paginated JSON containing findings for a specific target.
func (*API) ListIssues ¶
ListIssues returns a paginated JSON containing issues.
func (*API) ListLabels ¶
ListLabels returns a JSON containing existing labels for the applied filter.
func (*API) ListSources ¶
ListSources returns a paginated JSON containing sources.
func (*API) ListTargets ¶
ListTargets returns a paginated JSON containing targets.
func (*API) PatchFinding ¶
PatchFinding updates parts of a finding and returns a JSON containing the modified finding.
func (*API) StatsAssets ¶
StastAssetsPerSeverity returns statistics about the highest severity open vulnerability per asset and matching the specified filters.
func (*API) StatsCurrentExposure ¶
StastCurrentExposure returns statistics about the current exposure times matching specific filters.
func (*API) StatsExposure ¶
StastExposure returns statistics about the exposure times matching specific filters.
func (*API) StatsFixedIssues ¶
StatsFixedIssues returns statistics about the number of FIXED findings for each issue severity.
func (*API) StatsIssues ¶
StatsIssues returns a paginated JSON containing issues from a set of finding events.
func (*API) StatsMTTR ¶
StatsMTTR returns statistics about the mean time to remediate for each issue severity.
func (*API) StatsOpenIssues ¶
StatsOpenIssues returns statistics about the number of OPEN findings for each issue severity.
func (*API) TargetsSummary ¶
TargetsSummary returns a summary of findings count and score by target.