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

# Get Scan Report

> Retrieve scan report in HTML or SARIF format



## OpenAPI

````yaml /api-reference/openapi.json get /scan/{scan_id}/report
openapi: 3.0.0
info:
  title: Corgea API
  version: 1.0.0
  description: >-
    API for interacting with Corgea's scanning and vulnerability management
    features
servers:
  - url: https://www.corgea.app/api/v1
    description: Production server
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /scan/{scan_id}/report:
    get:
      tags:
        - Scans
        - Reports
      summary: Get Scan Report
      description: Retrieve scan report in HTML or SARIF format
      operationId: getScanReport
      parameters:
        - name: scan_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The ID of the scan
        - name: format
          in: query
          required: false
          schema:
            type: string
            enum:
              - sarif
              - html
            default: sarif
          description: Report format (html or sarif)
        - name: view
          in: query
          required: false
          schema:
            type: string
            default: cwe
          description: View type for HTML reports
        - name: urgency
          in: query
          required: false
          schema:
            type: string
            enum:
              - CR
              - HI
              - ME
              - LO
          description: Filter by urgency level
      responses:
        '200':
          description: Report retrieved successfully
          content:
            application/json:
              schema:
                description: SARIF report when format=sarif
                type: object
            text/html:
              schema:
                type: string
                description: HTML report when format=html
          headers:
            Content-Disposition:
              description: Filename for download when format=sarif
              schema:
                type: string
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Permission denied
        '404':
          description: Scan not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: Scan not found
        '500':
          description: Report generation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: >-
                      SARIF export failed. Please try again later or contact
                      support.
components:
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: API key for authentication
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 access token (JWT) in the Authorization header

````