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

# Scan abrufen

> Ruft Details zu einem bestimmten Scan ab



## OpenAPI

````yaml /de/api-reference/openapi.json get /scan/{scan_id}
openapi: 3.0.0
info:
  title: Corgea API
  version: 1.0.0
  description: >-
    API für die Interaktion mit den Scan- und
    Schwachstellenmanagement-Funktionen von Corgea
servers:
  - url: https://www.corgea.app/api/v1
    description: Produktionsserver
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /scan/{scan_id}:
    get:
      tags:
        - Scans
      summary: Scan abrufen
      description: Ruft Details zu einem bestimmten Scan ab
      operationId: getScan
      parameters:
        - name: scan_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID des Scans
      responses:
        '200':
          description: Scan-Details erfolgreich abgerufen
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  project:
                    type: string
                  repo:
                    type: string
                  branch:
                    type: string
                  status:
                    type: string
                    enum:
                      - scanning
                      - processing
                      - complete
                      - incomplete
                    description: >-
                      Scan-Fortschritt. "scanning" und "processing" kennzeichnen
                      laufende Zustände, "complete" einen abgeschlossenen Scan
                      und "incomplete" einen fehlgeschlagenen Scan.
                  engine:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                  time_taken:
                    type: number
                    nullable: true
                    description: >-
                      Dauer des Scans in Sekunden oder null, bis die
                      Verarbeitung abgeschlossen ist
                  git_sha:
                    type: string
                    nullable: true
                    description: Dem Scan zugeordnete Commit-SHA
                  metadata:
                    type: object
                    nullable: true
                    additionalProperties: true
                    description: >-
                      Vom Benutzer bereitgestellte, dem Scan zugeordnete
                      Metadaten
        '403':
          description: Zugriff verweigert
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Permission denied
        '404':
          description: Scan nicht gefunden
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: Scan doesn't exist
components:
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: API-Key für die Authentifizierung
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2-Access-Token (JWT) im Authorization-Header

````