Skip to main content
GET
Read a code security finding
To install and sign in to the CLI, see Call from the CLI.

Authorizations

x-coderabbitai-api-key
string
header
required

See Authentication for the key types and where to create a key.

Path Parameters

repository_id
string
required
Required string length: 1 - 255
finding_id
string<uuid>
required

Query Parameters

org_id
string

Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.

Minimum string length: 1
org_name
string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

Response

OK

id
string
required
repoId
string
required
repoName
string
required
category
string
required
severity
string
required
source
string
required
reachability
string
required
exploitability
string
required
filePath
string
required
startLine
number
required
endLine
number
required
description
string
required
recommendation
string
required
cwe
required
state
string
required
detectedAt
required
fingerprint
required
fixStatus
required
fixPrUrl
required
verificationSteps
required
publicationStatus
enum<string>
Available options:
published,
pending,
unresolved
reachabilityCallStack
string[]

Saved evidence frames. An empty list means no frames were captured.

reachabilityZoneContext
object
subsystemName
firstSeenAt
lastSeenAt
scanProvenance
object
secretAssessment
object
findingKind
enum<string>
Available options:
secret,
vulnerability
cvssScore

CVSS 4.0 Base score, when available.

Required range: 0 <= x <= 10
fixTaskId
string
tickets
object[]
kbSources
object[]