> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Read a code security finding (beta)

> Returns one code security finding with its severity, location, description, recommendation, state and fix status, including any fix task or pull request and tracker ticket delivery status and URLs.

Open Beta (This feature is currently in open beta. We are actively improving it based on your feedback. If you encounter any issues or have suggestions, please share them on our Discord community or visit the support page.)

> [tab] CLI Tool
>
> ```bash
> coderabbit api request "/security/repositories/$REPOSITORY_ID/findings/$FINDING_ID"
> ```
>
> To install and sign in to the CLI, see [Call from the CLI](https://docs.coderabbit.ai/api/cli.md).

> [tab] MCP Server
>
> An agent connected to the [CodeRabbit MCP server](https://docs.coderabbit.ai/api/mcp.md) runs this operation as the `get_security_finding` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "get_security_finding",
>     "arguments": {
>       "repository_id": "<repository_id>",
>       "finding_id": "<finding_id>"
>     }
>   }
> }
> ```


## OpenAPI

````yaml /openapi.json get /v1/security/repositories/{repository_id}/findings/{finding_id}
openapi: 3.0.0
info:
  title: CodeRabbit API
  version: 1.0.0
  description: >-
    Read and manage CodeRabbit reviews, coding tasks, Verify, Triage, security
    findings, Knowledge Base, configuration, and users for your organization.
servers:
  - url: https://api.coderabbit.ai
    description: US region
  - url: https://api.eu.coderabbit.ai
    description: EU region
security:
  - ApiKeyAuth: []
tags:
  - name: Organizations and repositories
  - name: Pull requests and reviews
  - name: Coding Agent
  - name: Coding environments
  - name: Verify
  - name: Triage
  - name: Security
  - name: Knowledge Base
  - name: Automations
  - name: Reports
  - name: Configuration
  - name: Connections
  - name: Users and roles
  - name: Usage and metrics
paths:
  /v1/security/repositories/{repository_id}/findings/{finding_id}:
    get:
      tags:
        - Security
      summary: Read a code security finding
      description: >-
        Returns one code security finding with its severity, location,
        description, recommendation, state and fix status, including any fix
        task or pull request and tracker ticket delivery status and URLs.
      operationId: get_security_finding
      parameters:
        - name: repository_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
        - name: finding_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: org_id
          in: query
          schema:
            type: string
            minLength: 1
            description: >-
              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.
          allowEmptyValue: true
          allowReserved: true
        - name: org_name
          in: query
          schema:
            type: string
            pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
            description: >-
              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.
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  publicationStatus:
                    enum:
                      - published
                      - pending
                      - unresolved
                    type: string
                  reachabilityCallStack:
                    type: array
                    items:
                      type: string
                    description: >-
                      Saved evidence frames. An empty list means no frames were
                      captured.
                  reachabilityZoneContext:
                    type: object
                    properties:
                      schemaVersion:
                        enum:
                          - 1
                      scanId:
                        type: string
                        minLength: 1
                      artifactScanId:
                        type: string
                        minLength: 1
                      capturedAt:
                        type: string
                        format: date-time
                      headRevision:
                        type: string
                      zone:
                        type: string
                        maxLength: 512
                      label:
                        enum:
                          - external
                          - internal
                          - tooling
                          - unknown
                        type: string
                      source:
                        enum:
                          - settings
                          - detected
                        type: string
                      evidence:
                        type: string
                      confidence:
                        enum:
                          - high
                          - medium
                          - low
                        type: string
                      reconSha256:
                        type: string
                        pattern: ^[a-f0-9]{64}$
                      rule:
                        type: object
                        properties:
                          id:
                            type: string
                          path:
                            type: string
                          reachability:
                            enum:
                              - external
                              - internal
                            type: string
                          setAt:
                            type: string
                            format: date-time
                          setBy:
                            type: object
                            properties:
                              providerUserId:
                                type: string
                              login:
                                type: string
                            required:
                              - providerUserId
                        required:
                          - id
                          - path
                          - reachability
                          - setAt
                          - setBy
                    required:
                      - schemaVersion
                      - scanId
                      - artifactScanId
                      - capturedAt
                      - zone
                      - label
                      - source
                      - evidence
                  subsystemName:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  firstSeenAt:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  lastSeenAt:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  scanProvenance:
                    type: object
                    properties:
                      scanId:
                        type: string
                      coverageScope:
                        anyOf:
                          - type: object
                            properties:
                              kind:
                                enum:
                                  - repository
                            required:
                              - kind
                            additionalProperties: false
                          - type: object
                            properties:
                              kind:
                                enum:
                                  - directories
                              directories: {}
                            required:
                              - kind
                            additionalProperties: false
                          - type: object
                            properties:
                              kind:
                                enum:
                                  - unavailable
                            required:
                              - kind
                            additionalProperties: false
                    required:
                      - scanId
                      - coverageScope
                  secretAssessment:
                    type: object
                    properties:
                      policyVersion:
                        enum:
                          - '2026-10-01'
                      scanVerification:
                        type: string
                        maxLength: 32
                      verificationCheckedAt:
                        type: string
                        format: date-time
                      verification:
                        enum:
                          - valid
                          - needs_validation
                          - invalid
                          - revoked
                          - unknown
                          - error
                        type: string
                      detectors:
                        type: array
                        maxItems: 100
                        items:
                          type: string
                          maxLength: 120
                      relatedLocations:
                        type: array
                        maxItems: 100
                        items:
                          type: object
                          properties:
                            file:
                              type: string
                              maxLength: 4096
                            startLine:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                            endLine:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                          required:
                            - file
                            - startLine
                            - endLine
                      status:
                        enum:
                          - assessed
                          - unassessed
                        type: string
                      classification:
                        enum:
                          - public_config
                          - synthetic_fixture
                          - private_credential
                          - non_credential
                          - uncertain
                        type: string
                      confidence:
                        enum:
                          - high
                          - medium
                          - low
                        type: string
                      environment:
                        enum:
                          - production
                          - sandbox
                          - unknown
                        type: string
                      impact:
                        enum:
                          - privileged_access
                          - limited_service
                          - unknown
                        type: string
                      reason:
                        enum:
                          - public_provider_role
                          - synthetic_value
                          - private_provider_role
                          - private_key_material
                          - authentication_usage
                          - not_authentication_material
                          - insufficient_context
                          - conflicting_evidence
                        type: string
                      missingEvidence:
                        type: array
                        maxItems: 5
                        items:
                          enum:
                            - usage
                            - provider_role
                            - environment
                            - permissions
                            - complete_value
                          type: string
                    required:
                      - policyVersion
                      - status
                      - classification
                      - confidence
                      - environment
                      - impact
                      - reason
                      - missingEvidence
                  id:
                    type: string
                  repoId:
                    type: string
                  repoName:
                    type: string
                  findingKind:
                    enum:
                      - secret
                      - vulnerability
                    type: string
                  category:
                    type: string
                  severity:
                    type: string
                  cvssScore:
                    anyOf:
                      - type: number
                        minimum: 0
                        maximum: 10
                      - type: string
                        nullable: true
                        enum:
                          - null
                    description: CVSS 4.0 Base score, when available.
                  source:
                    type: string
                  reachability:
                    type: string
                  exploitability:
                    type: string
                  filePath:
                    type: string
                  startLine:
                    type: number
                  endLine:
                    type: number
                  description:
                    type: string
                  recommendation:
                    type: string
                  cwe:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  state:
                    type: string
                  detectedAt:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  fingerprint:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  fixStatus:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  fixTaskId:
                    type: string
                  fixPrUrl:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  verificationSteps:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  tickets:
                    type: array
                    items:
                      type: object
                      properties:
                        provider:
                          enum:
                            - jira
                            - linear
                          type: string
                        status:
                          type: string
                        url:
                          anyOf:
                            - type: string
                            - type: string
                              nullable: true
                              enum:
                                - null
                      required:
                        - provider
                        - status
                        - url
                  kbSources:
                    type: array
                    items:
                      type: object
                      properties:
                        kb:
                          type: string
                        path:
                          type: string
                        url:
                          type: string
                      required:
                        - kb
                        - path
                required:
                  - id
                  - repoId
                  - repoName
                  - category
                  - severity
                  - source
                  - reachability
                  - exploitability
                  - filePath
                  - startLine
                  - endLine
                  - description
                  - recommendation
                  - cwe
                  - state
                  - detectedAt
                  - fingerprint
                  - fixStatus
                  - fixPrUrl
                  - verificationSteps
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - invalid_request
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - unauthenticated
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - forbidden
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - not_found
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - head_changed
                          - conflict
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - precondition_failed
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: Content too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - payload_too_large
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - rate_limit_exceeded
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - internal_error
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unavailable
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        See [Authentication](/api/authentication) for the key types and where to
        create a key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.