Skip to main content
GET
Preview a Security finding ticket
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}$
finding_kind
enum<string>
required

Use vulnerability for all Deep Scan findings, including AI-detected secrets.

Available options:
vulnerability
destination
enum<string>
required
Available options:
jira,
linear

Response

OK

title
string
required
metadata
object[]
required
description
string
required
suggestedPriority
enum<string>
required
Available options:
high,
medium,
low
defaultStatus
string
required
optionDestination
required
Available options:
jira,
linear
optionTargetRef
required
projectLabel
required