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

# Persist firmware compliance record (internal)

> Materialize policy-2.0 evidence through a firmware-run worker action.



## OpenAPI

````yaml /openapi/fleet-manager-openapi.yaml post /api/v1/firmware/verifications/{id}/compliance-record/
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}/compliance-record/:
    post:
      tags:
        - Firmware Verification
      summary: Persist firmware compliance record (internal)
      description: Materialize policy-2.0 evidence through a firmware-run worker action.
      operationId: api_v1_firmware_verifications_compliance_record_create
      parameters:
        - in: query
          name: dry_run
          schema:
            type: boolean
          description: Validate policy-2.0 evidence without creating a compliance record.
        - 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/FirmwareComplianceRecordWriteResponse'
          description: ''
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirmwareComplianceRecordWriteResponse'
          description: ''
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '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'
        '409':
          description: Policy-2.0 evidence is not available or conflicts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - firmware-compliance-record:write
        - cookieAuth: []
components:
  schemas:
    FirmwareComplianceRecordWriteResponse:
      type: object
      description: >-
        Validation result and optional record identity returned to the Temporal
        worker.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        dry_run:
          type: boolean
          readOnly: true
        compliance_status:
          allOf:
            - $ref: '#/components/schemas/FirmwareComplianceStateEnum'
          readOnly: true
      required:
        - compliance_status
        - dry_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'
    FirmwareComplianceStateEnum:
      enum:
        - compliant
        - non_compliant
        - partial
        - stale
        - unknown
      type: string
      description: |-
        * `compliant` - COMPLIANT
        * `non_compliant` - NON_COMPLIANT
        * `partial` - PARTIAL
        * `stale` - STALE
        * `unknown` - UNKNOWN
    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
  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.