> ## 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 policy snapshot audit record

> Return one operator-safe immutable policy snapshot projection.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml get /api/v1/firmware/policy-snapshots/{id}/
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/policy-snapshots/{id}/:
    get:
      tags:
        - Firmware Verification
      summary: Get firmware policy snapshot audit record
      description: Return one operator-safe immutable policy snapshot projection.
      operationId: api_v1_firmware_policy_snapshots_audit_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying this Firmware Policy Snapshot.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirmwarePolicySnapshotAudit'
          description: ''
        '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: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: The stored policy snapshot failed integrity validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - firmware-verification:read
        - cookieAuth: []
components:
  schemas:
    FirmwarePolicySnapshotAudit:
      type: object
      description: Operator projection of immutable policy evidence.
      properties:
        id:
          type: string
          format: uuid
        workflow_run_id:
          type: string
        device_id:
          type: string
          format: uuid
        approval_set_version:
          type: string
        policy_id:
          type: string
        digest_contract:
          $ref: '#/components/schemas/FirmwarePolicyDigestContractEnum'
        canonical_payload_digest:
          type: string
        approval_status:
          $ref: '#/components/schemas/FirmwarePolicyApprovalStatusEnum'
        approval_reference:
          type: string
        validation_status:
          $ref: '#/components/schemas/FirmwarePolicyCacheValidationStatusEnum'
        freshness_deadline:
          type: string
          format: date-time
        platform_class:
          type: string
        effective_target_level:
          type: string
        components:
          type: array
          items:
            $ref: '#/components/schemas/FirmwarePolicySnapshotAuditComponent'
        created_at:
          type: string
          format: date-time
      required:
        - approval_reference
        - approval_set_version
        - approval_status
        - canonical_payload_digest
        - components
        - created_at
        - device_id
        - digest_contract
        - effective_target_level
        - freshness_deadline
        - id
        - platform_class
        - policy_id
        - validation_status
        - workflow_run_id
    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'
    FirmwarePolicyDigestContractEnum:
      type: string
      enum:
        - jcs-sha256-v1
    FirmwarePolicyApprovalStatusEnum:
      type: string
      enum:
        - netbox_declared
    FirmwarePolicyCacheValidationStatusEnum:
      type: string
      enum:
        - valid
        - invalid
        - pending
        - missing
        - stale
        - scope_conflict
        - oversized
    FirmwarePolicySnapshotAuditComponent:
      type: object
      description: Safe expected-component summary without worker execution instructions.
      properties:
        component_key:
          type: string
        collector_admission_version:
          type: string
        expected_versions:
          type: array
          items:
            $ref: '#/components/schemas/FirmwarePolicySnapshotAuditExpectedVersion'
        evidence_authorities:
          type: array
          items:
            $ref: '#/components/schemas/FirmwareEvidenceAuthorityEnum'
      required:
        - component_key
        - evidence_authorities
        - expected_versions
    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
    FirmwarePolicySnapshotAuditExpectedVersion:
      type: object
      description: One immutable expected version in the operator audit projection.
      properties:
        version:
          type: string
        vendor:
          type: string
          nullable: true
        model_name:
          type: string
          nullable: true
      required:
        - model_name
        - vendor
        - version
    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
  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.