> ## 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 an existing security scan (beta)

> Follow a specific scan by repository and scan ID. Returns status, recorded start and completion times, finding counts, coverage and, when available, counts of assigned and completed investigation checks. Missing investigation data is unknown. A missing scan is null.

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/scans/$SCAN_ID?target=code"
> ```
>
> 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_scan` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "get_security_scan",
>     "arguments": {
>       "repository_id": "<repository_id>",
>       "scan_id": "<scan_id>",
>       "target": "code"
>     }
>   }
> }
> ```


## OpenAPI

````yaml /openapi.json get /v1/security/repositories/{repository_id}/scans/{scan_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}/scans/{scan_id}:
    get:
      tags:
        - Security
      summary: Read an existing security scan
      description: >-
        Follow a specific scan by repository and scan ID. Returns status,
        recorded start and completion times, finding counts, coverage and, when
        available, counts of assigned and completed investigation checks.
        Missing investigation data is unknown. A missing scan is null.
      operationId: get_security_scan
      parameters:
        - name: repository_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
        - name: scan_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: org_id
          in: query
          required: false
          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
          required: false
          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
        - name: target
          in: query
          required: true
          schema:
            enum:
              - code
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  scan:
                    anyOf:
                      - type: object
                        properties:
                          startedAt:
                            anyOf:
                              - type: string
                                format: date-time
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          completedAt:
                            anyOf:
                              - type: string
                                format: date-time
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          investigation:
                            type: object
                            properties:
                              expected:
                                type: integer
                                minimum: 0
                              missing:
                                type: integer
                                minimum: 0
                              legacy:
                                type: integer
                                minimum: 0
                              invalid:
                                type: integer
                                minimum: 0
                              skipped:
                                type: integer
                                minimum: 0
                              unfinished:
                                type: integer
                                minimum: 0
                              completedFinding:
                                type: integer
                                minimum: 0
                              completedClean:
                                type: integer
                                minimum: 0
                              completedInsufficientEvidence:
                                type: integer
                                minimum: 0
                              dropReasons:
                                type: object
                                additionalProperties:
                                  type: integer
                                  minimum: 0
                            required:
                              - expected
                              - missing
                              - legacy
                              - invalid
                              - skipped
                              - unfinished
                              - completedFinding
                              - completedClean
                              - completedInsufficientEvidence
                          status:
                            enum:
                              - pending
                              - running
                              - completed
                              - failed
                            type: string
                          failure:
                            anyOf:
                              - type: object
                                properties:
                                  code:
                                    type: string
                                  message:
                                    type: string
                                  retryable:
                                    type: boolean
                                  directoryRetryable:
                                    enum:
                                      - true
                                  directoryRetryRepoId:
                                    type: string
                                  scanId:
                                    type: string
                                required:
                                  - code
                                  - message
                                  - retryable
                                  - scanId
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          hasPreviousResults:
                            type: boolean
                          scanMode:
                            anyOf:
                              - type: string
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          isPartial:
                            type: boolean
                          completionOutcome:
                            type: string
                          deferredReason:
                            anyOf:
                              - type: string
                              - type: string
                                nullable: true
                                enum:
                                  - null
                          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
                          counts:
                            type: object
                            properties:
                              total:
                                type: number
                              critical:
                                type: number
                              high:
                                type: number
                              medium:
                                type: number
                              low:
                                type: number
                              verifiedActive:
                                type: number
                            required:
                              - total
                              - critical
                              - high
                              - medium
                              - low
                              - verifiedActive
                        required:
                          - status
                          - failure
                          - hasPreviousResults
                          - scanMode
                          - isPartial
                          - deferredReason
                          - counts
                      - type: string
                        nullable: true
                        enum:
                          - null
                required:
                  - scan
        '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.