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

# Get firmware verification report

> Return the policy-backed report through its public run identity.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/firmware/verifications/{id}/report/
openapi: 3.0.3
info:
  title: Fleet Manager API
  version: 1.0.0
  description: API for the Nscale Fleet Manager
servers: []
security: []
paths:
  /api/v1/firmware/verifications/{id}/report/:
    get:
      tags:
        - Firmware Verification
      summary: Get firmware verification report
      description: Return the policy-backed report through its public run identity.
      operationId: api_v1_firmware_verifications_report_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying this Firmware Verification Run.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirmwarePolicyVerificationArtifact'
          description: Versioned policy-backed firmware verification evidence.
        '401':
          description: Authentication credentials were not provided or are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to perform this action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The run has no available report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: The run has not produced a report yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: The stored report failed integrity validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Object storage is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - firmware-verification:read
        - cookieAuth: []
components:
  schemas:
    FirmwarePolicyVerificationArtifact:
      oneOf:
        - $ref: '#/components/schemas/FirmwarePolicyVerificationReport'
        - $ref: '#/components/schemas/FirmwarePolicyVerificationReportV2'
      discriminator:
        propertyName: schema_version
        mapping:
          policy-1.0: '#/components/schemas/FirmwarePolicyVerificationReport'
          policy-2.0: '#/components/schemas/FirmwarePolicyVerificationReportV2'
    ErrorResponse:
      type: object
      description: >-
        Uniform error body for every 4xx/5xx response. `detail` is a
        human-readable message, always present, safe to display to end users.
        `code` is the machine-readable identifier. `field_errors` lists
        per-input-field validation messages and is empty for non-field errors
        (auth, permission, not-found, conflict, server).
      required:
        - detail
        - code
        - field_errors
      properties:
        detail:
          type: string
        code:
          $ref: '#/components/schemas/ErrorCodeEnum'
        field_errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
    FirmwarePolicyVerificationReport:
      type: object
      properties:
        schema_version:
          type: string
        job_id:
          type: string
          format: uuid
        device_id:
          type: string
          format: uuid
        workflow_run_id:
          type: string
        temporal_workflow_id:
          type: string
        collection_started_at:
          type: string
          format: date-time
        collection_completed_at:
          type: string
          format: date-time
        evaluated_at:
          type: string
          format: date-time
        findings:
          type: array
          items:
            $ref: '#/components/schemas/GroupedFirmwareComponentFinding'
        current_compliance_state:
          $ref: '#/components/schemas/FirmwareComplianceStateEnum'
      required:
        - collection_completed_at
        - collection_started_at
        - current_compliance_state
        - device_id
        - evaluated_at
        - findings
        - job_id
        - schema_version
        - temporal_workflow_id
        - workflow_run_id
    FirmwarePolicyVerificationReportV2:
      type: object
      properties:
        schema_version:
          type: string
        job_id:
          type: string
          format: uuid
        device_id:
          type: string
          format: uuid
        workflow_run_id:
          type: string
        temporal_workflow_id:
          type: string
        collection_started_at:
          type: string
          format: date-time
        collection_completed_at:
          type: string
          format: date-time
        evaluated_at:
          type: string
          format: date-time
        findings:
          type: array
          items:
            $ref: '#/components/schemas/GroupedFirmwareComponentFinding'
        current_compliance_state:
          $ref: '#/components/schemas/FirmwareComplianceStateEnum'
        collection_vendor:
          type: string
          nullable: true
        observations:
          type: array
          items:
            $ref: '#/components/schemas/FirmwarePolicyEvidenceObservation'
        evidence_digest:
          type: string
          pattern: ^[a-f0-9]{64}$
        nic_dpu_collection:
          $ref: '#/components/schemas/FirmwarePolicyNicDpuCollection'
      required:
        - collection_completed_at
        - collection_started_at
        - collection_vendor
        - current_compliance_state
        - device_id
        - evaluated_at
        - evidence_digest
        - findings
        - job_id
        - observations
        - schema_version
        - temporal_workflow_id
        - workflow_run_id
    ErrorCodeEnum:
      type: string
      description: >-
        Stable machine-readable error identifier. New members may be added
        within this API version; clients must tolerate unknown values.
      enum:
        - error
        - invalid
        - parse_error
        - authentication_failed
        - not_authenticated
        - permission_denied
        - not_found
        - method_not_allowed
        - not_acceptable
        - unsupported_media_type
        - conflict
        - enrollment_infrastructure_reference_pending
        - enrollment_infrastructure_reference_changed
        - unprocessable_entity
        - throttled
        - service_unavailable
    FieldError:
      type: object
      description: One input field's validation messages.
      required:
        - field
        - messages
      properties:
        field:
          type: string
          description: >-
            Dotted path to the offending input field, or to the collection row
            when the whole row is invalid (e.g. `filters.end_date`,
            `memberships.0.role`, `memberships.0`).
        messages:
          type: array
          minItems: 1
          items:
            type: string
    GroupedFirmwareComponentFinding:
      type: object
      properties:
        component_key:
          type: string
        outcome:
          $ref: '#/components/schemas/FirmwareVerificationOutcomeEnum'
        members:
          type: array
          items:
            $ref: '#/components/schemas/GroupedFirmwareMemberFinding'
      required:
        - component_key
        - members
        - outcome
    FirmwareComplianceStateEnum:
      enum:
        - compliant
        - non_compliant
        - partial
        - stale
        - unknown
      type: string
      description: |-
        * `compliant` - COMPLIANT
        * `non_compliant` - NON_COMPLIANT
        * `partial` - PARTIAL
        * `stale` - STALE
        * `unknown` - UNKNOWN
    FirmwarePolicyEvidenceObservation:
      type: object
      properties:
        component_key:
          type: string
        native_family:
          $ref: '#/components/schemas/FirmwareNativeFamilyEnum'
        component_model:
          type: string
          nullable: true
        component_class:
          allOf:
            - $ref: '#/components/schemas/FirmwarePolicyEvidenceComponentClassEnum'
          nullable: true
        observed_version:
          type: string
          nullable: true
        error:
          allOf:
            - $ref: '#/components/schemas/FirmwareVerificationReasonEnum'
          nullable: true
        collection_source:
          $ref: '#/components/schemas/FirmwareEvidenceSourceEnum'
        collection_tool:
          type: string
          minLength: 1
        collected_at:
          type: string
          format: date-time
        expected_versions:
          type: array
          items:
            type: string
        evidence_authority:
          $ref: '#/components/schemas/FirmwareEvidenceAuthorityEnum'
      required:
        - collected_at
        - collection_source
        - collection_tool
        - component_class
        - component_key
        - error
        - evidence_authority
        - expected_versions
        - observed_version
    FirmwarePolicyNicDpuCollection:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/FirmwarePolicyNicDpuCollectionStatusEnum'
        collection_failed:
          type: boolean
        scanned_native_families:
          type: array
          items:
            $ref: '#/components/schemas/FirmwareNativeFamilyEnum'
          nullable: true
        issues:
          type: array
          items:
            $ref: '#/components/schemas/FirmwarePolicyNicDpuScanIssue'
        observations:
          type: array
          items:
            $ref: '#/components/schemas/FirmwarePolicyNicDpuObservation'
      required:
        - collection_failed
        - issues
        - observations
        - scanned_native_families
        - status
    FirmwareVerificationOutcomeEnum:
      enum:
        - compliant
        - non_compliant
        - missing
        - unknown
        - collection_failed
        - unsupported_component_classification
      type: string
      description: >-
        * `compliant` - COMPLIANT

        * `non_compliant` - NON_COMPLIANT

        * `missing` - MISSING

        * `unknown` - UNKNOWN

        * `collection_failed` - COLLECTION_FAILED

        * `unsupported_component_classification` -
        UNSUPPORTED_COMPONENT_CLASSIFICATION
    GroupedFirmwareMemberFinding:
      type: object
      properties:
        member_key:
          type: string
          nullable: true
        expected_versions:
          type: array
          items:
            type: string
        observed_version:
          type: string
          nullable: true
        outcome:
          $ref: '#/components/schemas/FirmwareVerificationOutcomeEnum'
        reason:
          allOf:
            - $ref: '#/components/schemas/FirmwareVerificationReasonEnum'
          nullable: true
        uncollectable_reason:
          allOf:
            - $ref: '#/components/schemas/KnownUncollectableReasonEnum'
          nullable: true
        detail:
          type: string
          nullable: true
      required:
        - detail
        - expected_versions
        - member_key
        - observed_version
        - outcome
        - reason
        - uncollectable_reason
    FirmwareNativeFamilyEnum:
      enum:
        - cx7
        - cx8
        - bf3
      type: string
      description: |-
        * `cx7` - CX7
        * `cx8` - CX8
        * `bf3` - BF3
    FirmwarePolicyEvidenceComponentClassEnum:
      enum:
        - bmc
        - bios
        - cpu
        - gpu
        - inforom
        - cpld
        - erot
        - fpga
        - pcie_switch
        - retimer
        - nic
        - dpu
        - nvos
        - nvme
        - psu
      type: string
      description: |-
        * `bmc` - BMC
        * `bios` - BIOS
        * `cpu` - CPU
        * `gpu` - GPU
        * `inforom` - INFOROM
        * `cpld` - CPLD
        * `erot` - EROT
        * `fpga` - FPGA
        * `pcie_switch` - PCIE_SWITCH
        * `retimer` - RETIMER
        * `nic` - NIC
        * `dpu` - DPU
        * `nvos` - NVOS
        * `nvme` - NVME
        * `psu` - PSU
    FirmwareVerificationReasonEnum:
      enum:
        - version_match
        - version_mismatch
        - component_not_observed
        - version_not_available
        - collection_unsupported
        - collection_unknown
        - collection_failed
        - unsupported_component_classification
      type: string
      description: >-
        * `version_match` - VERSION_MATCH

        * `version_mismatch` - VERSION_MISMATCH

        * `component_not_observed` - COMPONENT_NOT_OBSERVED

        * `version_not_available` - VERSION_NOT_AVAILABLE

        * `collection_unsupported` - COLLECTION_UNSUPPORTED

        * `collection_unknown` - COLLECTION_UNKNOWN

        * `collection_failed` - COLLECTION_FAILED

        * `unsupported_component_classification` -
        UNSUPPORTED_COMPONENT_CLASSIFICATION
    FirmwareEvidenceSourceEnum:
      enum:
        - bmc_vendor_scan
        - ssh_nvos
        - slurm
        - ironic_cleaning
        - fm_execution_worker
        - observability
        - manual
      type: string
      description: |-
        * `bmc_vendor_scan` - BMC_VENDOR_SCAN
        * `ssh_nvos` - SSH_NVOS
        * `slurm` - SLURM
        * `ironic_cleaning` - IRONIC_CLEANING
        * `fm_execution_worker` - FM_EXECUTION_WORKER
        * `observability` - OBSERVABILITY
        * `manual` - MANUAL
    FirmwareEvidenceAuthorityEnum:
      enum:
        - bmc_firmware_inventory
        - slurm_nvme_inventory
        - slurm_nic_dpu_running_v1
      type: string
      description: |-
        * `bmc_firmware_inventory` - BMC_FIRMWARE_INVENTORY
        * `slurm_nvme_inventory` - SLURM_NVME_INVENTORY
        * `slurm_nic_dpu_running_v1` - SLURM_NIC_DPU_RUNNING_V1
    FirmwarePolicyNicDpuCollectionStatusEnum:
      enum:
        - success
        - partial
        - unknown
        - unsupported
      type: string
      description: |-
        * `success` - SUCCESS
        * `partial` - PARTIAL
        * `unknown` - UNKNOWN
        * `unsupported` - UNSUPPORTED
    FirmwarePolicyNicDpuScanIssue:
      type: object
      properties:
        native_family:
          $ref: '#/components/schemas/FirmwareNativeFamilyEnum'
        error:
          type: string
        collection_source:
          $ref: '#/components/schemas/FirmwareEvidenceSourceEnum'
        collection_tool:
          type: string
        collected_at:
          type: string
          format: date-time
      required:
        - collected_at
        - collection_source
        - collection_tool
        - error
        - native_family
    FirmwarePolicyNicDpuObservation:
      type: object
      properties:
        native_family:
          $ref: '#/components/schemas/FirmwareNativeFamilyEnum'
        component_key:
          type: string
        observed_version:
          type: string
          nullable: true
        error:
          type: string
          nullable: true
        collection_source:
          $ref: '#/components/schemas/FirmwareEvidenceSourceEnum'
        collection_tool:
          type: string
        collected_at:
          type: string
          format: date-time
      required:
        - collected_at
        - collection_source
        - collection_tool
        - component_key
        - error
        - native_family
        - observed_version
    KnownUncollectableReasonEnum:
      enum:
        - not_in_firmware_inventory
        - hmc_endpoint_not_supported
        - slurm_identity_not_yet_bridged
        - slurm_nic_dpu_declaration_not_admitted
        - slurm_not_approved_for_device_class
        - target_selector_not_yet_bridged
        - slurm_nvme_member_count_mismatch
        - slurm_nic_dpu_member_layout_mismatch
        - nvme_member_profile_not_found
        - nvme_platform_target_not_declared
      type: string
      description: >-
        * `not_in_firmware_inventory` - NOT_IN_FIRMWARE_INVENTORY

        * `hmc_endpoint_not_supported` - HMC_ENDPOINT_NOT_SUPPORTED

        * `slurm_identity_not_yet_bridged` - SLURM_IDENTITY_NOT_YET_BRIDGED

        * `slurm_nic_dpu_declaration_not_admitted` -
        SLURM_NIC_DPU_DECLARATION_NOT_ADMITTED

        * `slurm_not_approved_for_device_class` -
        SLURM_NOT_APPROVED_FOR_DEVICE_CLASS

        * `target_selector_not_yet_bridged` - TARGET_SELECTOR_NOT_YET_BRIDGED

        * `slurm_nvme_member_count_mismatch` - SLURM_NVME_MEMBER_COUNT_MISMATCH

        * `slurm_nic_dpu_member_layout_mismatch` -
        SLURM_NIC_DPU_MEMBER_LAYOUT_MISMATCH

        * `nvme_member_profile_not_found` - NVME_MEMBER_PROFILE_NOT_FOUND

        * `nvme_platform_target_not_declared` -
        NVME_PLATFORM_TARGET_NOT_DECLARED
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

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