REST API - Findings

Get finding details

Changed on
get/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)

Response

idstring required

Finding UUID

display_idstring required

Human-readable id (KEY-FD-NUMBER).

numberinteger required

Per-organization sequence number behind display_id.

titlestring required
categorystring required
severity'critical' | 'high' | 'medium' | 'low' | 'info' required
state'open' | 'true_positive' | 'false_positive' | 'accepted_risk' | 'resolved' | 'closed' required
descriptionstring required
affected_filestring required
affected_codestring required
proof_of_conceptstring nullable required
tagsstring[] required
scan_idstring nullable required
found_atstring required
updated_atstring required
resolved_atstring nullable required

Timestamp of the most recent transition to resolved (ISO 8601). Null if never resolved.

occurrence_countnumber required
repo_urlstring nullable required
scan_typestring nullable required

Example response

{
  "display_id": "HAC-FD-1104",
  "number": 1104
}

Changes

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status