Get Finding

curl --request GET \
  --url https://api.example.com/api/findings/{id}

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "scan_id": "98765432-e89b-12d3-a456-426614174111",
    "repo_id": "11111111-e89b-12d3-a456-426614174222",
    "source": "ai",
    "status": "open",
    "severity": "high",
    "confidence": "high",
    "title": "SQL Injection vulnerability in user query",
    "description": "User input is concatenated directly into SQL query without sanitization, allowing potential SQL injection attacks.",
    "cwe_id": "CWE-89",
    "cve_id": null,
    "file_path": "src/database/queries.rs",
    "line_start": 45,
    "line_end": 47,
    "code_snippet": "let query = format!(\"SELECT * FROM users WHERE id = {}\", user_id);",
    "suggested_patch": null,
    "poc_exploit_json": null,
    "poc_validated": false,
    "fingerprint": "a7f3b9c2d1e4f5a6b7c8d9e0f1a2b3c4",
    "agent_reasoning": "The code constructs a SQL query using string formatting with unsanitized user input, creating a classic SQL injection vector.",
    "created_at": "2026-03-12T10:30:00Z",
    "updated_at": "2026-03-12T10:30:00Z"
  }
}

GET

api

findings

{id}

Get Finding

curl --request GET \
  --url https://api.example.com/api/findings/{id}

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "scan_id": "98765432-e89b-12d3-a456-426614174111",
    "repo_id": "11111111-e89b-12d3-a456-426614174222",
    "source": "ai",
    "status": "open",
    "severity": "high",
    "confidence": "high",
    "title": "SQL Injection vulnerability in user query",
    "description": "User input is concatenated directly into SQL query without sanitization, allowing potential SQL injection attacks.",
    "cwe_id": "CWE-89",
    "cve_id": null,
    "file_path": "src/database/queries.rs",
    "line_start": 45,
    "line_end": 47,
    "code_snippet": "let query = format!(\"SELECT * FROM users WHERE id = {}\", user_id);",
    "suggested_patch": null,
    "poc_exploit_json": null,
    "poc_validated": false,
    "fingerprint": "a7f3b9c2d1e4f5a6b7c8d9e0f1a2b3c4",
    "agent_reasoning": "The code constructs a SQL query using string formatting with unsanitized user input, creating a classic SQL injection vector.",
    "created_at": "2026-03-12T10:30:00Z",
    "updated_at": "2026-03-12T10:30:00Z"
  }
}

Path Parameters

string

required

The unique UUID of the finding to retrieve

Response

Returns a Finding object containing complete details about the security vulnerability.

data

object

The finding object

Show Finding Properties

string

Unique identifier (UUID) for the finding

scan_id

string

UUID of the scan that discovered this finding

repo_id

string

UUID of the repository where the finding was detected

source

string

Source of the finding detection

ai - Detected by AI-powered analysis
static - Found by static analysis tools
dependencies - Identified in dependency scan

status

string

Current triage status of the finding

open - Newly discovered, awaiting review
confirmed - Verified as a true positive
dismissed - Acknowledged but not prioritized
false_positive - Determined to be incorrect
fixed - Remediation has been applied

severity

string

Severity level of the vulnerability

critical - Requires immediate attention
high - Significant risk, prioritize remediation
medium - Moderate risk
low - Minor risk or informational

confidence

string

Confidence level in the finding accuracy

high - Strong evidence supporting the finding
medium - Moderate confidence
low - Requires additional verification

title

string

Short, human-readable title describing the vulnerability

description

string

Detailed explanation of the security issue and its implications

cwe_id

string

Common Weakness Enumeration identifier (e.g., “CWE-79”)

cve_id

string

Common Vulnerabilities and Exposures identifier (e.g., “CVE-2024-1234”)

file_path

string

Relative path to the file containing the vulnerability

line_start

integer

Starting line number of the vulnerable code

line_end

integer

Ending line number if the issue spans multiple lines

code_snippet

string

Excerpt of the vulnerable code for context

suggested_patch

string

Proposed code changes to remediate the vulnerability

poc_exploit_json

object

Proof-of-concept exploit data demonstrating the vulnerability

poc_validated

boolean

Whether the proof-of-concept has been validated

fingerprint

string

Unique hash identifying this class of vulnerability for deduplication

agent_reasoning

string

Detailed reasoning from the AI agent explaining why this was flagged

created_at

string

ISO 8601 timestamp when the finding was created

updated_at

string

ISO 8601 timestamp of the last update

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "scan_id": "98765432-e89b-12d3-a456-426614174111",
    "repo_id": "11111111-e89b-12d3-a456-426614174222",
    "source": "ai",
    "status": "open",
    "severity": "high",
    "confidence": "high",
    "title": "SQL Injection vulnerability in user query",
    "description": "User input is concatenated directly into SQL query without sanitization, allowing potential SQL injection attacks.",
    "cwe_id": "CWE-89",
    "cve_id": null,
    "file_path": "src/database/queries.rs",
    "line_start": 45,
    "line_end": 47,
    "code_snippet": "let query = format!(\"SELECT * FROM users WHERE id = {}\", user_id);",
    "suggested_patch": null,
    "poc_exploit_json": null,
    "poc_validated": false,
    "fingerprint": "a7f3b9c2d1e4f5a6b7c8d9e0f1a2b3c4",
    "agent_reasoning": "The code constructs a SQL query using string formatting with unsanitized user input, creating a classic SQL injection vector.",
    "created_at": "2026-03-12T10:30:00Z",
    "updated_at": "2026-03-12T10:30:00Z"
  }
}

Error Responses

error

object

Show Error Properties

success

boolean

Always false for error responses

code

integer

HTTP status code

message

string

Human-readable error description

404 Not Found

Returned when the specified finding does not exist.

{
  "success": false,
  "code": 404,
  "message": "Finding '123e4567-e89b-12d3-a456-426614174000' not found"
}

500 Internal Server Error

Returned when a database or server error occurs.

{
  "success": false,
  "code": 500,
  "message": "Failed to fetch finding: database connection error"
}

Stream Scan Progress

Update Finding Status

⌘I

Build docs developers (and LLMs) love

Get started for free Talk to us

Authentication

Repositories

Scans

Findings

Settings

Webhooks

Get Finding

Path Parameters

Response

Error Responses

404 Not Found

500 Internal Server Error

Build docs developers (and LLMs) love

Authentication

Repositories

Scans

Findings

Settings

Webhooks

​Path Parameters

​Response

​Error Responses

​404 Not Found

​500 Internal Server Error

Build docs developers (and LLMs) love

Path Parameters

Response

Error Responses

404 Not Found

500 Internal Server Error