> ## 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 > Reads a scan within an authorized repository. Partial and directory coverage are explicit; a missing scan is null, not a completed scan. ## OpenAPI ````yaml /openapi.json get /v1/security/repositories/{repository_id}/scans/{scan_id} openapi: 3.0.3 info: title: CodeRabbit API spec version: 1.0.0 servers: - url: https://api.coderabbit.ai security: - ApiKeyAuth: [] paths: /v1/security/repositories/{repository_id}/scans/{scan_id}: get: tags: - Security summary: Read an existing security scan description: >- Reads a scan within an authorized repository. Partial and directory coverage are explicit; a missing scan is null, not a completed scan. 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 allowEmptyValue: true allowReserved: true - name: target in: query required: true schema: enum: - code - dependencies - sbom - secrets type: string allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: type: object properties: scan: anyOf: - type: object properties: 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: '400' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '401': description: '401' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '403': description: '403' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '404': description: '404' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '409': description: '409' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '412': description: '412' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '413': description: '413' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '429': description: '429' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '500': description: '500' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '503': description: '503' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-coderabbitai-api-key description: >- API key for authentication. You can create an API key from the CodeRabbit dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.