> ## 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.

# Detection abrufen

> Ruft Details zu einer bestimmten Detection ab

Auch unter `/api/v1/issue/{issue_id}` erreichbar, dem früheren Namen dieses Endpunkts, der weiterhin mit denselben Parametern und derselben Antwort unterstützt wird.



## OpenAPI

````yaml /de/api-reference/openapi.json get /detections/{issue_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
  - url: https://eu.corgea.app/api/v1
    description: EU-Produktionsserver
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /detections/{issue_id}:
    get:
      tags:
        - Detections
      summary: Detection abrufen
      description: >-
        Ruft Details zu einer bestimmten Detection ab


        Auch unter `/api/v1/issue/{issue_id}` erreichbar, dem früheren Namen
        dieses Endpunkts, der weiterhin mit denselben Parametern und derselben
        Antwort unterstützt wird.
      operationId: getIssue
      parameters:
        - name: issue_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID des Issues
        - name: show_full_code
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Gibt an, ob die Response den vollständigen Code enthalten soll
        - name: include_metadata
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            Vom Scanner bereitgestellte Kennungen in issue.metadata aufnehmen.
            Standardmäßig nicht enthalten; bei Anforderung ist metadata null,
            wenn keine Kennungen verfügbar sind.
        - name: include_reachability
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Details zur Endpoint-Erreichbarkeit des Issues einschließen.
        - name: generate_fix
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            Setzen Sie den Wert auf true, um einen geeigneten fehlenden Fix im
            Hintergrund zu generieren. Ohne den Parameter oder mit false wird
            der aktuelle Issue-Zustand zurückgegeben, ohne die Fix-Generierung
            zu starten.
        - name: wait_for_the_fix
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            Wartet vor der Antwort auf die Fix-Generierung im Hintergrund. Gilt
            nur, wenn generate_fix auf true gesetzt ist und ein geeigneter Fix
            fehlt. Die Wartezeit ist begrenzt (standardmäßig 120 Sekunden);
            läuft die Generierung noch, meldet die Antwort generating. Rufen Sie
            das Issue erneut ab, um den fertigen Fix abzurufen.
      responses:
        '200':
          description: Issue-Details erfolgreich abgerufen
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  issue:
                    $ref: '#/components/schemas/IssueDetail'
        '404':
          description: Issue nicht gefunden
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: Issue not found
components:
  schemas:
    IssueDetail:
      type: object
      properties:
        finding_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            ID des Findings, von dem dieses Issue eine Detection ist: über
            Rescans hinweg dieselbe. Null bei einem Issue, das erfasst wurde,
            bevor es Findings gab.
        id:
          type: string
          format: uuid
        scan_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - open
            - fix_in_progress
            - fixed
            - false_positive
            - accepted_risk
            - duplicate
        urgency:
          type: string
          enum:
            - CR
            - HI
            - ME
            - LO
          description: >-
            Dringlichkeitscode: CR (kritisch), HI (hoch), ME (mittel) oder LO
            (niedrig).
        created_at:
          type: string
          format: date-time
        first_detection_date:
          type: string
          format: date-time
          description: >-
            Zeitpunkt, zu dem Corgea dieses Issue erstmals erkannt hat, über
            alle Scans hinweg, in denen es auftrat. Entspricht created_at, wenn
            dies die früheste Erkennung ist.
        classification:
          type: object
          nullable: true
          description: >-
            Wenn die CWE unbekannt ist oder die Klassifizierung eine freie
            Bezeichnung ist, enthalten id und name die ursprüngliche
            Klassifizierungsbezeichnung und description ist null. Eine leere
            Klassifizierung wird als null zurückgegeben.
          properties:
            id:
              type: string
              example: CWE-123
            name:
              type: string
              example: Vulnerability Name
            description:
              type: string
              nullable: true
        location:
          $ref: '#/components/schemas/IssueLocation'
        details:
          type: object
          properties:
            explanation:
              type: string
            policy_guidance:
              type: object
              nullable: true
              description: >-
                Hinweise aus der Richtlinie, die für dieses Issue gilt, oder
                null, wenn keine Richtlinienhinweise gelten.
              properties:
                policy:
                  type: string
                  description: Name der Richtlinie
                text:
                  type: string
                  description: Text des Hinweises
            full_code:
              type: string
              description: >-
                Vollständiger Quellcode der betroffenen Datei. Wird nur
                zurückgegeben, wenn show_full_code true ist.
        auto_triage:
          $ref: '#/components/schemas/AutoTriage'
        auto_fix_suggestion:
          $ref: '#/components/schemas/AutoFixSuggestion'
        assigned_to:
          $ref: '#/components/schemas/AssignedTo'
        scanner_metadata:
          type: object
          description: Vom Scanner bereitgestellte, dem Issue zugeordnete Metadaten.
          additionalProperties:
            type: string
        reachability:
          $ref: '#/components/schemas/IssueReachabilityDetail'
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Vom Scanner bereitgestellte Kennungen für dieses Problem, etwa eine
            Fortify instance_id oder ein Checkmarx deep_link. Nur bei
            include_metadata=true enthalten; null, wenn keine Kennungen
            verfügbar sind.
        status_comment:
          type: string
          nullable: true
          description: >-
            Gespeicherter Kommentar zur Statusänderung; null, wenn nicht
            vorhanden.
    IssueLocation:
      type: object
      properties:
        file:
          type: object
          properties:
            name:
              type: string
            language:
              type: string
            path:
              type: string
            git_hash:
              type: string
              nullable: true
              description: >-
                Für die gescannte Datei erfasster Git-Hash. Wird nur von den
                Endpoints zurückgegeben, die Issues auflisten.
        project:
          type: object
          properties:
            name:
              type: string
            branch:
              type: string
            git_sha:
              type: string
        line_number:
          type: integer
        sink_line_number:
          type: integer
          nullable: true
          description: >-
            Zeile der Senke im Datenfluss, wenn sich die Senke in dieser Datei
            befindet, andernfalls null. Wird nur beim Abrufen eines einzelnen
            Issues zurückgegeben.
    AutoTriage:
      type: object
      properties:
        false_positive_detection:
          type: object
          properties:
            status:
              type: string
              enum:
                - valid
                - false_positive
                - pending
            reasoning:
              description: >-
                Begründung der False-Positive-Einstufung, sofern verfügbar, auch
                wenn kein Fix generiert wurde.
              type: string
              nullable: true
    AutoFixSuggestion:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - fix_available
            - no_fix
            - generating
            - false_positive
            - on_hold
            - unsupported
            - plan
          description: >-
            Aktuelle Fix-Verfügbarkeit. Beim Abrufen eines Issues wird
            standardmäßig ein geeigneter fehlender Fix im Hintergrund generiert.
            Während dieser Generierung lautet der Status generating; rufen Sie
            das Issue erneut ab, bis die Generierung abgeschlossen ist. Ist die
            Generierung deaktiviert oder wird kein Fix erzeugt, lautet der
            Status no_fix.
        patch:
          type: object
          properties:
            diff:
              type: string
              description: >-
                Patch im Unified-Diff-Format. Gibt eine leere Zeichenfolge
                zurück, wenn der Fix keinen Diff enthält.
            explanation:
              type: string
              description: Erläuterung, wie der Fix die Schwachstelle behebt
            full_code:
              type: string
              description: >-
                Vollständiger Quellcode der Datei mit angewendetem Fix. Wird nur
                zurückgegeben, wenn show_full_code true ist und ein Fix
                vorhanden ist.
    AssignedTo:
      type: object
      nullable: true
      description: >-
        Dem Issue zugewiesener Benutzer oder null, wenn das Issue nicht
        zugewiesen ist.
      properties:
        id:
          type: string
          description: ID des zugewiesenen Benutzers.
        email:
          type: string
          format: email
          description: E-Mail-Adresse des zugewiesenen Benutzers.
        name:
          type: string
          nullable: true
          description: >-
            Anzeigename des zugewiesenen Benutzers oder null, wenn nicht
            verfügbar.
    IssueReachabilityDetail:
      type: object
      description: >-
        Details zur Endpoint-Erreichbarkeit, die zurückgegeben werden, wenn
        include_reachability true ist.
      properties:
        is_reachable:
          type: boolean
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/IssueReachabilityEndpoint'
    IssueReachabilityEndpoint:
      type: object
      properties:
        path:
          type: string
        method:
          type: string
        file_path:
          type: string
          nullable: true
        line_number:
          type: integer
          nullable: true
        pathways:
          type: array
          items:
            $ref: '#/components/schemas/IssueReachabilityPathway'
    IssueReachabilityPathway:
      type: object
      properties:
        pathway_id:
          type: string
        total_depth:
          type: integer
        confidence_score:
          type: number
        target:
          type: object
          additionalProperties: true
        steps:
          type: array
          items:
            $ref: '#/components/schemas/IssueReachabilityStep'
    IssueReachabilityStep:
      type: object
      properties:
        depth:
          type: integer
        file_path:
          type: string
        line_number:
          type: integer
        function_name:
          type: string
        target_line_number:
          type: integer
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: >-
        API-Key für die Authentifizierung API-Tokens inaktiver Benutzer werden
        abgelehnt.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2-Access-Token (JWT) im Authorization-Header

````

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