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

# Get scan details

> Returns full scan details including associated vulnerabilities. A pentest's list omits dependency CVE findings. A supply-chain scan's findings are all dependency CVEs. The response embeds them only when the token also holds the `dependencies:read` scope. Without that scope, the list is empty.



## OpenAPI

````yaml /openapi.json get /scans/{scanId}
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: Search
    description: Search across issues, pentests, PR reviews, chats, assets and schedules.
  - 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.
  - name: License
    description: Self-hosted license state, entitlements, and aggregate usage.
  - name: Supply Chain
    description: >-
      SBOM inventory, supply-chain findings, scans, and policy for connected
      repositories.
  - name: CLI
    description: >-
      Device authorization endpoints that let the Strix CLI and coding agents
      sign in and receive an API token.
  - name: Billing
    description: Credit balance, agent-payable top-ups, and automatic top-up settings.
  - name: Workspaces
    description: List, create, and switch workspaces.
  - name: Asset Discovery
    description: >-
      Passive reconnaissance runs that map the organization's external attack
      surface, and the discovered-asset inventory they fill.
  - name: Containers
    description: >-
      Container registries, tracked images, image scans, findings, and SBOM
      components.
  - name: Run Logs
    description: Persisted engine logs and the diagnostics bundle of a self-hosted install.
paths:
  /scans/{scanId}:
    get:
      tags:
        - Scans
      summary: Get scan details
      description: >-
        Returns full scan details including associated vulnerabilities. A
        pentest's list omits dependency CVE findings. A supply-chain scan's
        findings are all dependency CVEs. The response embeds them only when the
        token also holds the `dependencies:read` scope. Without that scope, the
        list is empty.
      operationId: getScan
      parameters:
        - $ref: '#/components/parameters/ScanId'
      responses:
        '200':
          description: Scan details with vulnerabilities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanWithVulnerabilities'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          description: The SBOM was replaced while it was being read. Retry the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth:
            - scans:read
components:
  parameters:
    ScanId:
      description: UUID of the scan. Use the `id` field of a scan from `listScans`.
      name: scanId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    ScanWithVulnerabilities:
      allOf:
        - $ref: '#/components/schemas/Scan'
        - type: object
          properties:
            vulnerabilities:
              type: array
              items:
                $ref: '#/components/schemas/Vulnerability'
            cloud_connections:
              type: array
              items:
                $ref: '#/components/schemas/ScanCloudConnection'
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable explanation of the error.
        code:
          type: string
          description: >-
            Stable machine-readable error code. `insufficient_scope` means the
            token does not hold the scope that this endpoint requires.
        required_scope:
          $ref: '#/components/schemas/ApiV1Scope'
          description: >-
            Scope that the caller must add to the token. Returned with the
            `insufficient_scope` code.
        docs:
          type: string
          format: uri
          description: Documentation page that explains how to resolve the error.
        hint:
          type: string
          description: >-
            One instruction that resolves the error. For `insufficient_scope`, a
            CLI session gets the `strix cloud session scopes set full` or `strix
            cloud login --scope-profile full` command, and an API token gets the
            settings page where the user creates a token with the scope. When
            the owner's role cannot hold the scope, the hint asks for a role
            change instead.
      required:
        - detail
    Scan:
      type: object
      properties:
        auth_checked_at:
          type:
            - string
            - 'null'
          format: date-time
        auth_detail:
          type:
            - string
            - 'null'
          description: Short, secret-free explanation of the login outcome.
        auth_failure_code:
          type:
            - string
            - 'null'
          description: >-
            Category of the login failure (e.g. invalid_credentials,
            mfa_required_not_configured).
        auth_status:
          type:
            - string
            - 'null'
          description: >-
            Whether the agent could log in with the provisioned test
            credentials, when any were configured: succeeded | failed.
        cloud_connection_checked_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Time when the orchestrator checked the selected cloud connections.
        cloud_connection_status:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/CloudConnectionStatusEntry'
          description: Attachment outcome for each cloud connection selected for the scan.
        completed_at:
          type: string
          format: date-time
        connector_id:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        domain_ids:
          type: array
          items:
            type: string
            format: uuid
        duration:
          type:
            - string
            - 'null'
        executive_summary:
          type: string
        findings:
          $ref: '#/components/schemas/ScanFindings'
        id:
          type: string
          format: uuid
        is_retest:
          type: boolean
          description: >-
            True for a retest scan. A retest scan verifies one or more existing
            issues and does not appear in the scan list.
        knowledge_resource_pins:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/RunKnowledgeResourcePin'
          description: >-
            Public provider-resource metadata selected specifically for this
            scan.
        live_prompt_enabled:
          type: boolean
        live_prompt_ready:
          type: boolean
        max_budget_usd:
          type:
            - number
            - 'null'
          description: 'Self-hosted only: per-scan LLM cost limit (USD), if one was set.'
        budget_policy:
          type:
            - string
            - 'null'
          enum:
            - stop
            - pause
            - null
          description: >-
            Self-hosted only: cost-limit policy the scan runs with, if a limit
            was set.
        methodology:
          type: string
        org_knowledge_enabled:
          type:
            - boolean
            - 'null'
        parent_scan_id:
          type:
            - string
            - 'null'
          description: 'Retest scans only: the scan that found the source issue.'
        parent_scan_title:
          type:
            - string
            - 'null'
          description: 'Retest scans only: the title of the parent scan.'
        recommendations:
          type: string
        repositories:
          type: array
          items:
            $ref: '#/components/schemas/Repository'
        repository_ids:
          type: array
          items:
            type: string
            format: uuid
        repository_commits:
          type:
            - object
            - 'null'
          description: >-
            The commit each repository was tested at, keyed by the repository
            URL from `repositories`. The value is the full commit SHA that the
            scan checked out. Null for a scan with no repository target and for
            a scan that ran before Strix recorded commits.
          additionalProperties:
            type: string
        retest_source:
          type:
            - object
            - 'null'
          description: >-
            Retest scans that a Retest issue request started: the current state
            of that issue. Null for a retest that a rerun started, even when
            `retest_target_count` is 1.
          properties:
            id:
              type: string
            title:
              type: string
            severity:
              $ref: '#/components/schemas/VulnerabilitySeverity'
            status:
              $ref: '#/components/schemas/VulnerabilityStatus'
          required:
            - id
            - title
            - severity
            - status
        retest_source_scan_id:
          type:
            - string
            - 'null'
          description: >-
            Retest scans that a rerun started: the scan whose open issues the
            retest verifies.
        retest_source_vulnerability_id:
          type:
            - string
            - 'null'
          description: >-
            Retest scans that a Retest issue request started: the issue that the
            retest verifies. Null for a retest that a rerun started, even when
            `retest_target_count` is 1.
        retest_target_count:
          type: integer
          description: >-
            Retest scans only: the number of issues that the retest verifies. 0
            for other scans.
        scan_tier:
          type:
            - string
            - 'null'
          enum:
            - lite
            - standard
            - ultra
            - null
          description: >-
            Scan tier the run used. A null value means the scan was launched
            without a tier.
        scan_type:
          type: string
          enum:
            - whitebox
            - blackbox
        schedule_id:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/ScanStatus'
        stop_reason:
          type:
            - string
            - 'null'
          enum:
            - budget_exceeded
            - rate_limited
            - agents_incomplete
            - null
          description: >-
            Why the engine ended the scan before its agents finished: the cost
            limit was reached, the model provider rate-limited the scan, or a
            sub-agent never finished. Null when the agents finished on their
            own. A retest scan that stopped early does not mark any issue fixed;
            its issues without a finding are `inconclusive`.
        status_detail:
          type:
            - string
            - 'null'
          description: >-
            Secret-free explanation of `status_detail_code`. Self-hosted
            installs return the exact infrastructure message, for example the
            Kubernetes scheduler message. The hosted product returns generic
            wording. For `budget_near_limit` every install returns the cost
            figures, for example `The run used $96.13 of its $100.00 cost limit
            (96%)…`.
        status_detail_code:
          oneOf:
            - $ref: '#/components/schemas/RunStatusDetailCode'
            - type: 'null'
          description: >-
            Reason code behind the current status. Set when the launch path or
            the infrastructure set the status, or when a `completed` scan ended
            early near its cost limit (`budget_near_limit`). `null` for an
            ordinary engine-owned status.
        technical_analysis:
          type: string
        title:
          type: string
        updated_at:
          type: string
          format: date-time
        urls:
          type: array
          items:
            type: string
        user_id:
          type: string
      required:
        - id
        - user_id
        - title
        - status
        - created_at
    Vulnerability:
      type: object
      properties:
        id:
          type: string
        scan_id:
          type:
            - string
            - 'null'
          format: uuid
        pr_review_id:
          type:
            - string
            - 'null'
          format: uuid
        title:
          type: string
        description:
          type: string
        cve:
          type:
            - string
            - 'null'
        cvss:
          type:
            - number
            - 'null'
        created_at:
          type: string
          format: date-time
        potential_risk_saving:
          type:
            - number
            - 'null'
        risk_saving_description:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/VulnerabilityStatus'
        severity:
          $ref: '#/components/schemas/VulnerabilitySeverity'
        impact:
          type:
            - string
            - 'null'
        endpoint:
          type:
            - string
            - 'null'
        method:
          type:
            - string
            - 'null'
        target:
          type:
            - string
            - 'null'
        technical_analysis:
          type:
            - string
            - 'null'
        poc_description:
          type:
            - string
            - 'null'
        poc_script_code:
          type:
            - string
            - 'null'
        code_diff:
          type:
            - string
            - 'null'
        code_file:
          type:
            - string
            - 'null'
        code_before:
          type:
            - string
            - 'null'
        code_after:
          type:
            - string
            - 'null'
        cwe:
          type:
            - array
            - 'null'
          items:
            type: string
        code_locations:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/CodeLocation'
        remediation_steps:
          type:
            - string
            - 'null'
        fix_pr_body:
          type:
            - string
            - 'null'
        evidence:
          type:
            - string
            - 'null'
        assumptions:
          type:
            - string
            - 'null'
        fix_effort:
          $ref: '#/components/schemas/FixEffort'
        cvss_breakdown:
          oneOf:
            - $ref: '#/components/schemas/CVSSBreakdown'
            - type: 'null'
        status_changed_at:
          type:
            - string
            - 'null'
          format: date-time
        status_changed_by:
          type:
            - string
            - 'null'
        status_note:
          type:
            - string
            - 'null'
        original_severity:
          $ref: '#/components/schemas/VulnerabilitySeverity'
        severity_changed_at:
          type:
            - string
            - 'null'
          format: date-time
        severity_changed_by:
          type:
            - string
            - 'null'
        severity_override_reason:
          type:
            - string
            - 'null'
        retest_of_vulnerability_id:
          type:
            - string
            - 'null'
        display_number:
          type:
            - integer
            - 'null'
          description: Human-readable STRIX-ID number.
        location_meta:
          $ref: '#/components/schemas/LocationMeta'
        latest_retest:
          $ref: '#/components/schemas/VulnerabilityRetest'
        fix_pr_eligible:
          type: boolean
        fix_pr_reason:
          type:
            - string
            - 'null'
        fix_pr_url:
          type:
            - string
            - 'null'
        cvss_adjustment:
          oneOf:
            - $ref: '#/components/schemas/CvssAdjustment'
            - type: 'null'
      required:
        - id
        - title
        - description
        - status
        - severity
        - created_at
    ScanCloudConnection:
      type: object
      required:
        - id
        - slug
        - provider
        - label
        - account
        - notes
        - applies_to_domain_ids
        - applies_to_repository_ids
        - project_name
        - tool_hint
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
        provider:
          type: string
        label:
          type: string
        account:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        applies_to_domain_ids:
          type: array
          items:
            type: string
            format: uuid
        applies_to_repository_ids:
          type: array
          items:
            type: string
            format: uuid
        project_name:
          type:
            - string
            - 'null'
        tool_hint:
          type:
            - string
            - 'null'
    ApiV1Scope:
      type: string
      enum:
        - scans:read
        - scans:write
        - vulnerabilities:read
        - vulnerabilities:write
        - dependencies:read
        - schedules:read
        - schedules:write
        - assets:read
        - assets:write
        - organizations:read
        - organizations:write
        - members:read
        - members:write
        - invitations:read
        - invitations:write
        - webhooks:read
        - webhooks:write
        - tokens:write
        - audit:read
        - pr_reviews:read
        - pr_reviews:write
        - connectors:read
        - connectors:write
        - knowledge:read
        - knowledge:write
        - uploads:write
        - integrations:read
        - integrations:write
        - chat:read
        - chat:write
        - scans:message
        - analytics:read
        - llm:read
        - llm:write
        - test_users:read
        - test_users:write
        - discovery:read
        - discovery:write
        - license:read
        - supply_chain:read
        - supply_chain:write
        - billing:read
        - billing:write
        - containers:read
        - containers:write
        - logs:read
    CloudConnectionStatusEntry:
      type: object
      required:
        - connection_id
        - provider
        - name
        - status
        - tool_count
        - reason
      properties:
        connection_id:
          type: string
        provider:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - attached
            - failed
        tool_count:
          type:
            - integer
            - 'null'
        reason:
          type:
            - string
            - 'null'
          enum:
            - not_ready
            - duplicate_name
            - connect_failed
            - client_unavailable
            - null
    ScanFindings:
      type: object
      properties:
        total:
          type: integer
        critical:
          type: integer
        high:
          type: integer
        medium:
          type: integer
        low:
          type: integer
      required:
        - total
        - critical
        - high
        - medium
        - low
    RunKnowledgeResourcePin:
      type: object
      additionalProperties: false
      properties:
        connection_id:
          type: string
          minLength: 1
          description: Organization cloud connection that owns the resource.
        page_id:
          type: string
          minLength: 1
          description: Provider-specific opaque resource identifier.
        label:
          type: string
          minLength: 1
          maxLength: 200
        url:
          type:
            - string
            - 'null'
          format: uri
        guidance:
          type: string
          maxLength: 500
          description: >-
            Optional context: what the resource holds and when Strix should read
            it.
      required:
        - connection_id
        - page_id
        - label
        - url
    Repository:
      type: object
      properties:
        url:
          type: string
        branch:
          type: string
        provider:
          type: string
      required:
        - url
        - branch
        - provider
    VulnerabilitySeverity:
      type: string
      enum:
        - critical
        - high
        - medium
        - low
    VulnerabilityStatus:
      type: string
      enum:
        - open
        - in_progress
        - snoozed
        - fixed
        - ignored
        - not_affected
    ScanStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - cancelled
    RunStatusDetailCode:
      type: string
      enum:
        - sandbox_pending
        - config_missing
        - llm_not_configured
        - secrets_missing
        - connector_unavailable
        - credentials_unreadable
        - image_pull_failed
        - pod_unschedulable
        - pod_rejected
        - container_config_failed
        - volume_failed
        - sandbox_ended
        - sandbox_timeout
        - docker_unavailable
        - sandbox_create_failed
        - launch_failed
        - retest_already_running
        - watchdog_timeout
        - launch_no_telemetry
        - relaunch_failed
        - relaunches_exhausted
        - engine_failed
        - budget_near_limit
      description: >-
        Machine-readable reason behind a run status. `sandbox_pending` means the
        run still waits for the sandbox. `budget_near_limit` qualifies a
        `completed` scan: the run used 85% or more of its cost limit, so Strix
        stopped the investigation early and the result may be incomplete.
        `retest_already_running` qualifies a `failed` retest that never ran:
        another retest already held one of its issues when it was launched. All
        other codes explain a failure that the launch path or the infrastructure
        set, not the engine.
    CodeLocation:
      type: object
      properties:
        file:
          type: string
        start_line:
          type: integer
        end_line:
          type: integer
        snippet:
          type: string
        label:
          type: string
        fix_before:
          type: string
        fix_after:
          type: string
      required:
        - file
        - start_line
    FixEffort:
      type: string
      enum:
        - trivial
        - low
        - medium
        - high
    CVSSBreakdown:
      type: object
      properties:
        attack_vector:
          type:
            - string
            - 'null'
        attack_complexity:
          type:
            - string
            - 'null'
        privileges_required:
          type:
            - string
            - 'null'
        user_interaction:
          type:
            - string
            - 'null'
        scope:
          type:
            - string
            - 'null'
        confidentiality:
          type:
            - string
            - 'null'
        integrity:
          type:
            - string
            - 'null'
        availability:
          type:
            - string
            - 'null'
    LocationMeta:
      type:
        - object
        - 'null'
      properties:
        branch:
          type: string
        provider:
          type: string
        repo_url:
          type: string
    VulnerabilityRetest:
      type:
        - object
        - 'null'
      description: >-
        The newest retest of the issue. The value is null when nobody retested
        the issue.
      properties:
        scan_id:
          type: string
          description: The retest scan. Read it with `GET /scans/{scanId}`.
        outcome:
          $ref: '#/components/schemas/RetestOutcome'
        inconclusive_reason:
          type:
            - string
            - 'null'
          description: >-
            Why an `inconclusive` retest could not verify the issue, in the
            retest agent's words. Null for every other outcome, and when the
            retest gave no reason; the retest scan's trace has the details.
        started_at:
          type: string
          format: date-time
      required:
        - scan_id
        - outcome
        - inconclusive_reason
        - started_at
    CvssAdjustment:
      type: object
      description: >-
        Manual CVSS adjustment and the rating before the first adjustment. A
        label-only severity change clears this record without changing the
        numeric score.
      properties:
        breakdown:
          oneOf:
            - $ref: '#/components/schemas/CvssV31BaseMetrics'
            - type: 'null'
        score:
          type:
            - number
            - 'null'
        vector:
          type:
            - string
            - 'null'
        severity:
          oneOf:
            - $ref: '#/components/schemas/VulnerabilitySeverity'
            - type: 'null'
        reason:
          type:
            - string
            - 'null'
        adjusted_by:
          type:
            - string
            - 'null'
        adjusted_at:
          type:
            - string
            - 'null'
          format: date-time
        original:
          oneOf:
            - type: object
              properties:
                score:
                  type:
                    - number
                    - 'null'
                vector:
                  type:
                    - string
                    - 'null'
                severity:
                  type:
                    - string
                    - 'null'
            - type: 'null'
    RetestOutcome:
      type: string
      enum:
        - running
        - still_present
        - inconclusive
        - not_reproduced
        - failed
        - cancelled
      description: >-
        The state of a retest. `running` means the retest scan is pending or
        running. `still_present` means the retest reproduced the issue.
        `inconclusive` means the retest completed but could not verify the
        issue, for example because the target did not respond; the issue keeps
        its status. If the service was taken down on purpose, close these issues
        with `POST /vulnerabilities/bulk-update` and `status: fixed`.
        `not_reproduced` means the retest completed and did not find the issue.
        `failed` and `cancelled` mirror the retest scan status.
    CvssV31BaseMetrics:
      type: object
      description: The eight CVSS v3.1 base metric selections.
      required:
        - attack_vector
        - attack_complexity
        - privileges_required
        - user_interaction
        - scope
        - confidentiality
        - integrity
        - availability
      properties:
        attack_vector:
          type: string
          enum:
            - 'N'
            - A
            - L
            - P
        attack_complexity:
          type: string
          enum:
            - L
            - H
        privileges_required:
          type: string
          enum:
            - 'N'
            - L
            - H
        user_interaction:
          type: string
          enum:
            - 'N'
            - R
        scope:
          type: string
          enum:
            - U
            - C
        confidentiality:
          type: string
          enum:
            - 'N'
            - L
            - H
        integrity:
          type: string
          enum:
            - 'N'
            - L
            - H
        availability:
          type: string
          enum:
            - 'N'
            - L
            - H
  responses:
    Unauthorized:
      description: Missing or invalid API token.
      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'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint or CLI device login. Include
        as `Authorization: Bearer <token>`. Requests made with a managed CLI
        session also include `X-Strix-Workspace: <organization_id>` to pin a
        process to the workspace it started in; recovery endpoints report the
        current workspace after a concurrent switch.

````

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