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

# Download scan report

> Generate and download a report for a completed scan. Report downloads require an Enterprise plan.



## OpenAPI

````yaml /openapi.json get /scans/{scanId}/report
openapi: 3.1.0
info:
  title: Strix API
  version: 1.0.0
  description: >-
    Public REST API for the Strix autonomous penetration testing platform.
    Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks.
servers:
  - url: /api/v1
    description: Strix v1 API
security:
  - BearerAuth: []
tags:
  - name: Scans
    description: Launch, monitor, and manage security scans.
  - name: Vulnerabilities
    description: View and triage discovered vulnerabilities.
  - name: Assets
    description: Domains and repositories registered for scanning.
  - name: Schedules
    description: Recurring scan schedules (Pro plan).
  - name: Tokens
    description: Manage API tokens for authentication.
  - name: Webhooks
    description: Configure webhook subscriptions for real-time event notifications.
  - name: Organization
    description: Workspace configuration for the authenticated organization.
  - name: Members
    description: Manage organization members and roles.
  - name: Invitations
    description: List and revoke organization invitations.
  - name: PR Reviews
    description: Automated security review of pull requests.
  - name: Connectors
    description: Network connectors for scanning internal/private targets.
  - name: Knowledge
    description: >-
      Organization knowledge base: documents, policies, and repo profiles that
      steer the agent.
  - name: Uploads
    description: Upload source/code/documentation archives for whitebox scans.
  - name: Integrations
    description: Third-party integrations (GitLab, Bitbucket, ticketing).
  - name: Chat
    description: Conversational agent sessions.
  - name: Analytics
    description: Aggregate dashboard analytics.
  - name: Test Users
    description: >-
      Per-domain test accounts (with optional MFA) the agent authenticates as
      during scans.
paths:
  /scans/{scanId}/report:
    get:
      tags:
        - Scans
      summary: Download scan report
      description: >-
        Generate and download a report for a completed scan. Report downloads
        require an Enterprise plan.
      operationId: getScanReport
      parameters:
        - $ref: '#/components/parameters/ScanId'
        - name: format
          in: query
          description: >-
            Report format. Formats other than "technical" require an Enterprise
            plan.
          schema:
            type: string
            enum:
              - technical
              - retest
              - attestation
              - executive_summary
            default: technical
        - name: type
          in: query
          description: File type for the rendered report. DOCX requires an Enterprise plan.
          schema:
            type: string
            enum:
              - pdf
              - docx
            default: pdf
        - name: providerName
          in: query
          description: >-
            White-label provider name shown on the report cover (Enterprise
            branding). Trimmed to 80 characters.
          schema:
            type: string
        - name: memberName0
          in: query
          description: >-
            Name of the first "prepared by" team member for white-label
            branding. Up to two members are credited, so memberName1 is also
            accepted. Trimmed to 120 characters.
          schema:
            type: string
        - name: memberEmail0
          in: query
          description: >-
            Email of the first "prepared by" team member for white-label
            branding. Up to two members are credited, so memberEmail1 is also
            accepted. Trimmed to 120 characters.
          schema:
            type: string
            format: email
      responses:
        '200':
          description: >-
            Report file. Content type is `application/pdf` by default, or the
            DOCX media type when `type=docx`.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.wordprocessingml.document:
              schema:
                type: string
                format: binary
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - scans:read
components:
  parameters:
    ScanId:
      name: scanId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient permissions or missing scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint. Include as `Authorization:
        Bearer <token>`.

````