REST API - Findings

Update finding state, severity, and/or duplicate link

patch/findings/{id}

Request

  • Base URL
    https://api.hacktron.ai/v1
  • URL
    https://api.hacktron.ai/v1/findings/{id}
  • Auth
    API key in header X-Api-Key

Path parameters

idstring required

Finding UUID or display id (KEY-FD-NUMBER, e.g. HAC-FD-1104)

Request body

state'open' | 'true_positive' | 'false_positive' | 'accepted_risk' | 'resolved' | 'closed'

New finding state

severity'critical' | 'high' | 'medium' | 'low' | 'info'

New severity level

state_reasonstring

Reason for the state change (defaults to reason if omitted)

severity_reasonstring

Reason for the severity change (defaults to reason if omitted)

reasonstring

Shorthand reason applied to both state and severity changes when their specific reason is not provided

duplicate_ofstring nullable

UUID of the canonical finding to mark this finding as a duplicate of, or null to unmark. The target must be in the same repository.

Response

idstring required
state'open' | 'true_positive' | 'false_positive' | 'accepted_risk' | 'resolved' | 'closed' required
severity'critical' | 'high' | 'medium' | 'low' | 'info' required
duplicate_ofstring nullable required

UUID of the canonical finding this duplicates, if any.

Changes

No recorded changes to this operation across all 2 revisions of this API.