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

# Obtener detección

> Obtiene los detalles de una detección concreta

También disponible en `/api/v1/issue/{issue_id}`, el nombre anterior de este endpoint, que sigue siendo compatible con los mismos parámetros y la misma respuesta.



## OpenAPI

````yaml /es/api-reference/openapi.json get /detections/{issue_id}
openapi: 3.0.0
info:
  title: API de Corgea
  version: 1.0.0
  description: >-
    API para interactuar con las funciones de escaneo y gestión de
    vulnerabilidades de Corgea
servers:
  - url: https://www.corgea.app/api/v1
    description: Servidor de producción
  - url: https://eu.corgea.app/api/v1
    description: Servidor de producción de la UE
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /detections/{issue_id}:
    get:
      tags:
        - Detecciones
      summary: Obtener detección
      description: >-
        Obtiene los detalles de una detección concreta


        También disponible en `/api/v1/issue/{issue_id}`, el nombre anterior de
        este endpoint, que sigue siendo compatible con los mismos parámetros y
        la misma respuesta.
      operationId: getIssue
      parameters:
        - name: issue_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID del hallazgo
        - name: show_full_code
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Indica si se debe incluir el código completo en la respuesta
        - name: include_metadata
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            Incluye los identificadores proporcionados por el escáner en
            issue.metadata. Se omite de forma predeterminada; al solicitarlo,
            metadata es null si no hay identificadores disponibles.
        - name: include_reachability
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Incluye los detalles de alcanzabilidad de endpoints del hallazgo.
        - name: generate_fix
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            Establece el valor en true para iniciar en segundo plano la
            generación de una corrección que falte y cumpla los requisitos. Si
            se omite o es false, se devuelve el estado actual del hallazgo sin
            iniciar la generación.
        - name: wait_for_the_fix
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            Espera a que se genere la corrección en segundo plano antes de
            responder. Solo se aplica cuando generate_fix es true y falta una
            corrección que cumpla los requisitos. La espera es limitada (120
            segundos de forma predeterminada); si la generación sigue pendiente,
            la respuesta indica generating. Vuelve a consultar el hallazgo para
            comprobar si la corrección está lista.
      responses:
        '200':
          description: Detalles del hallazgo obtenidos correctamente
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  issue:
                    $ref: '#/components/schemas/IssueDetail'
        '404':
          description: Hallazgo no encontrado
          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 del finding del que esta incidencia es una detección: el mismo
            entre reescaneos. Null en una incidencia ingerida antes de que
            existieran los findings.
        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: 'Código de urgencia: CR (crítica), HI (alta), ME (media) o LO (baja).'
        created_at:
          type: string
          format: date-time
        first_detection_date:
          type: string
          format: date-time
          description: >-
            Fecha en que Corgea detectó este hallazgo por primera vez, entre
            todos los escaneos en los que apareció. Coincide con created_at
            cuando esta es la primera detección.
        classification:
          type: object
          nullable: true
          description: >-
            Si el CWE es desconocido o la clasificación es una etiqueta de texto
            libre, id y name contienen la etiqueta de clasificación original y
            description es null. Una clasificación vacía se devuelve como null.
          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: >-
                Indicaciones de la política que se aplica a este hallazgo, o
                null si no se aplica ninguna.
              properties:
                policy:
                  type: string
                  description: Nombre de la política
                text:
                  type: string
                  description: Texto de las indicaciones
            full_code:
              type: string
              description: >-
                Código fuente completo del archivo afectado. Solo se devuelve
                cuando show_full_code es true.
        auto_triage:
          $ref: '#/components/schemas/AutoTriage'
        auto_fix_suggestion:
          $ref: '#/components/schemas/AutoFixSuggestion'
        assigned_to:
          $ref: '#/components/schemas/AssignedTo'
        scanner_metadata:
          type: object
          description: Metadatos proporcionados por el escáner y asociados al hallazgo.
          additionalProperties:
            type: string
        reachability:
          $ref: '#/components/schemas/IssueReachabilityDetail'
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Identificadores proporcionados por el escáner para este problema,
            como un instance_id de Fortify o un deep_link de Checkmarx. Solo se
            incluye cuando include_metadata=true; es null si no hay
            identificadores disponibles.
        status_comment:
          type: string
          nullable: true
          description: Comentario registrado del cambio de estado; null si no existe.
    IssueLocation:
      type: object
      properties:
        file:
          type: object
          properties:
            name:
              type: string
            language:
              type: string
            path:
              type: string
            git_hash:
              type: string
              nullable: true
              description: >-
                Hash de Git registrado para el archivo escaneado. Solo lo
                devuelven los endpoints que listan hallazgos.
        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: >-
            Línea del sumidero (sink) del flujo de datos cuando está en este
            archivo; en caso contrario, null. Solo se devuelve al obtener un
            hallazgo individual.
    AutoTriage:
      type: object
      properties:
        false_positive_detection:
          type: object
          properties:
            status:
              type: string
              enum:
                - valid
                - false_positive
                - pending
            reasoning:
              description: >-
                Motivo de la clasificación como falso positivo cuando está
                disponible, incluso si no se generó ninguna corrección.
              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: >-
            Disponibilidad actual de la corrección. Consultar un hallazgo inicia
            de forma predeterminada la generación en segundo plano de una
            corrección que falte y cumpla los requisitos. Mientras esa
            generación está pendiente, el estado es generating; vuelve a
            consultar el hallazgo hasta que finalice. Si la generación está
            desactivada o no se produce ninguna corrección, el estado es no_fix.
        patch:
          type: object
          properties:
            diff:
              type: string
              description: >-
                Parche en formato diff unificado. Devuelve una cadena vacía
                cuando la corrección no tiene diff.
            explanation:
              type: string
              description: Explicación de cómo la corrección resuelve la vulnerabilidad
            full_code:
              type: string
              description: >-
                Código fuente completo del archivo con la corrección aplicada.
                Solo se devuelve cuando show_full_code es true y existe una
                corrección.
    AssignedTo:
      type: object
      nullable: true
      description: >-
        Usuario asignado al hallazgo, o null cuando el hallazgo no está
        asignado.
      properties:
        id:
          type: string
          description: ID del usuario asignado.
        email:
          type: string
          format: email
          description: Dirección de correo electrónico del usuario asignado.
        name:
          type: string
          nullable: true
          description: >-
            Nombre para mostrar del usuario asignado, o null si no está
            disponible.
    IssueReachabilityDetail:
      type: object
      description: >-
        Detalles de alcanzabilidad de endpoints que se devuelven cuando
        include_reachability es true.
      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: >-
        Clave de API para la autenticación Se rechazan los tokens de API de
        usuarios inactivos.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acceso OAuth2 (JWT) en el encabezado Authorization

````

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