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

# Read active and recovered drive-health condition episodes

> Authenticated, tenant-scoped read of hardware and collection conditions.
Each condition names its affected server and, when attributable, immutable
drive identity, severity, observed evidence and recommended next step.
Collection failures are distinct from hardware diagnoses. Stable episode
IDs deduplicate unchanged conditions; resolved_at records recovery only
when fresh evidence covers the condition. Anonymous collection incidents
deduplicate by server and path, independently of anonymous hardware IDs.
Nonzero cumulative counters describe historical totals; measured increases
are separate conditions. NVMe command-error increases and consumed rated
endurance are advisories, rather than standalone evidence of media failure.
Resolved history is bounded to 64 episodes per condition scope and 90 days.
Reads initiate no repair, device mutation or provider action.




## OpenAPI

````yaml /techstack/reference/api/openapi.yaml get /api/v1/monitor/drive-health/alerts
openapi: 3.1.0
info:
  title: kombify-TechStack API
  description: >
    REST API for kombify-TechStack -- the hybrid cloud control plane for
    homelabs.


    kombify-TechStack manages infrastructure through a spec-driven architecture:

    validate YAML specs via CUE, generate OpenTofu configurations, and manage

    nodes through a gRPC agent protocol.


    ## Authentication


    Authenticated endpoints accept an OIDC/JWKS bearer token or an API key

    where documented. Self-hosted TechStack defaults to Pocket ID as identity

    provider. SaaS routes enter through the edge with Auth0 as the platform

    identity provider. PocketBase session exchange remains legacy migration

    compatibility only.


    ## Response Format


    **Success:** `{ "data": <object>, "meta": { "total": int, "page": int,
    "per_page": int } }`


    **Error:** `{ "error": { "code": "<ERROR_CODE>", "message": "...",
    "details": <any> } }`


    ## Pagination


    List endpoints accept `page` (default: 1) and `per_page` (default: 20, max:
    100) query parameters.
  version: 1.0.0
  contact:
    name: kombify
    url: https://kombify.io
  license:
    name: Apache-2.0 AND GPL-3.0
    url: https://github.com/KombiverseLabs/kombify-TechStack/blob/main/LICENSE
servers:
  - url: https://api.kombify.io/v1/techstack
    description: >-
      Production canonical (via Cloudflare edge gateway, strip-prefix). Clients
      MUST use this projection. The Gateway strips /v1/techstack and re-adds
      /api/v1 at the origin, so it resolves the /api/v1/* paths below cleanly.
  - url: http://localhost:5260
    description: Local development
  - url: https://techstack.kombify.io
    description: Production (direct, no Gateway prefix)
  - url: https://api.kombify.io/v1/orchestrator
    description: >-
      Legacy StackKit-Orchestrator projection of the same origin. RETAINED for
      backward compatibility with existing consumers only. Do NOT use for mobile
      or new clients: combined with the /api/v1/* paths it double-resolves
      (yielding /v1/orchestrator/api/v1/...). Prefer /v1/techstack.
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Health checks and service info (no auth required)
  - name: Instance
    description: Local instance identity and enrollment metadata
  - name: Stacks
    description: Stack lifecycle management (create, provision, deploy, destroy)
  - name: Stacks - Specs
    description: Access persisted specification chain (intent, requirements, unified)
  - name: Stacks - Import/Export
    description: Import and export StackKits stack-spec.yaml configurations
  - name: Stacks - Drift
    description: Infrastructure drift detection and resolution
  - name: Unifier
    description: Spec validation, analysis, unification, and IaC generation pipeline
  - name: StackKits
    description: Infrastructure template catalog
  - name: Add-ons
    description: Add-on detection and registry
  - name: Workers
    description: Worker node registration and management
  - name: Servers
    description: Canonical server lifecycle, connection, and health state
  - name: Inventory
    description: >-
      Owner-scoped sanitized server and service read models for UI, API, and MCP
      clients
  - name: Pre-Checks
    description: Pre-deployment hardware and software validation
  - name: Agents
    description: Connected gRPC agent management and commands
  - name: Jobs
    description: Background job monitoring and SSE streaming
  - name: Discovery
    description: Network device discovery and SSH testing
  - name: Features
    description: Feature flags (read-only; managed centrally via the kombify Admin API)
  - name: Monthly Runtime
    description: Provider-free user API for subscription-backed stack runtime control
  - name: Runtime
    description: Recent runtime/deploy logs (job/deploy progress + container tail)
  - name: Wallet
    description: >-
      Redacted recovery-item wallet with biometric/platform-reauth-gated reveal.
      List responses strip secret/totp; reveal requires a fresh trusted-reauth
      HMAC proof (5-minute window) and is audited server-side.
  - name: Trust
    description: Pairing tokens for worker enrollment
  - name: Client Binding
    description: >-
      Short-lived HTTPS pairing for a second client and normal OIDC account
      handoff
  - name: Tunnel
    description: Cloudflare tunnel management for NAT traversal
  - name: Backups
    description: Database backup management (admin only)
  - name: Auth
    description: Authentication mode and SSO configuration
  - name: Metrics
    description: Prometheus-compatible instance metrics for admin/infra scrapers
  - name: Internal
    description: >-
      Internal SaaS-only APIs, including servicecall-protected executor
      contracts
paths:
  /api/v1/monitor/drive-health/alerts:
    get:
      tags:
        - Metrics
      summary: Read active and recovered drive-health condition episodes
      description: >
        Authenticated, tenant-scoped read of hardware and collection conditions.

        Each condition names its affected server and, when attributable,
        immutable

        drive identity, severity, observed evidence and recommended next step.

        Collection failures are distinct from hardware diagnoses. Stable episode

        IDs deduplicate unchanged conditions; resolved_at records recovery only

        when fresh evidence covers the condition. Anonymous collection incidents

        deduplicate by server and path, independently of anonymous hardware IDs.

        Nonzero cumulative counters describe historical totals; measured
        increases

        are separate conditions. NVMe command-error increases and consumed rated

        endurance are advisories, rather than standalone evidence of media
        failure.

        Resolved history is bounded to 64 episodes per condition scope and 90
        days.

        Reads initiate no repair, device mutation or provider action.
      operationId: getMonitorDriveHealthAlerts
      parameters:
        - $ref: '#/components/parameters/driveHealthServerId'
      responses:
        '200':
          description: >-
            Active and retained recovered episodes across the selected
            tenant/server scope
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/DriveHealthAlertsResponse'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          $ref: '#/components/responses/DriveHealthUnavailable'
components:
  parameters:
    driveHealthServerId:
      name: server_id
      in: query
      required: false
      description: >-
        Restrict evidence to one server within the authenticated tenant; an
        unobserved server remains explicitly missing.
      schema:
        type: string
        maxLength: 128
  schemas:
    DriveHealthAlertsResponse:
      type: object
      required:
        - generated_at
        - alerts
      properties:
        generated_at:
          type: string
          format: date-time
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/DriveHealthAlert'
    ResponseMeta:
      type: object
      properties:
        total:
          type: integer
        page:
          type: integer
        per_page:
          type: integer
        managed_runtime_inventory_complete:
          type: boolean
          description: >-
            True only when the managed RuntimeLease authority was configured and
            read successfully for this inventory response.
        worker_inventory_sha256:
          type: string
          pattern: ^[0-9a-f]{64}$
          description: >-
            Stable digest of the complete worker identity, attachment,
            freshness, and managed RuntimeLease authority snapshot used for
            pagination.
        managed_runtime_active_lease_ids:
          type: array
          items:
            type: string
          description: >-
            Canonically sorted IDs of visible managed RuntimeLeases classified
            as active for inventory and cleanup. This visibility projection is
            not capacity reservation or release authority.
        managed_runtime_inactive_lease_ids:
          type: array
          items:
            type: string
          description: >-
            Canonically sorted IDs of visible managed RuntimeLeases classified
            as cancelled or archived for inventory and cleanup. Inactive state
            does not prove provider absence or release managed-server capacity.
        managed_runtime_lease_generation_digests:
          type: array
          items:
            type: object
            required:
              - lease_id
              - resource_generation_digest
            properties:
              lease_id:
                type: string
              resource_generation_digest:
                type: string
                pattern: ^[0-9a-f]{64}$
          description: >-
            Canonically sorted opaque bindings from each visible managed
            RuntimeLease ID to its exact provider-resource generation. Missing
            coverage makes destructive inventory proof invalid while leaving
            ordinary dashboard inventory readable.
        managed_runtime_duplicate_lease_ids:
          type: array
          items:
            type: string
          description: >-
            Managed RuntimeLease IDs represented by multiple persisted worker
            rows before UI projection deduplication; must be empty for
            destructive inventory proof.
        managed_runtime_attachment_conflict_lease_ids:
          type: array
          items:
            type: string
          description: >-
            Canonically sorted caller-visible managed RuntimeLease IDs with a
            conflicting tenant-wide worker attachment; must be empty for
            destructive inventory proof and never exposes foreign private lease
            or worker details.
    DriveHealthAlert:
      type: object
      required:
        - id
        - worker_id
        - server_id
        - category
        - code
        - severity
        - message
        - evidence
        - recommended_step
        - first_seen_at
        - last_seen_at
      properties:
        id:
          type: string
          format: uuid
          description: Stable condition episode identity.
        worker_id:
          type: string
        condition_key:
          type: string
          description: >-
            Stable server/path availability key for anonymous collection
            incidents; does not identify physical hardware.
        server_id:
          type: string
        drive_id:
          type: string
          description: >-
            Attributable drive identity; absent on server or anonymous path
            collection conditions.
        category:
          type: string
          enum:
            - collection
            - hardware
        code:
          type: string
          enum:
            - collection
            - stale
            - observation
            - disconnected
            - smart_failed
            - self_test_failed
            - attribute_failed
            - nvme_warning
            - wear
            - spare
            - temperature
            - media_errors
            - media_errors_increase
            - error_log_entries_increase
            - reallocated_sectors
            - reallocated_sectors_increase
            - pending_sectors
            - pending_sectors_increase
            - uncorrectable_sectors
            - uncorrectable_sectors_increase
        severity:
          type: string
          enum:
            - info
            - warning
            - critical
        message:
          type: string
          description: Technical fallback; customer clients localize by condition code.
        evidence:
          type: object
          additionalProperties:
            type: string
          description: >-
            Measured values, source/time/path and condition-specific
            interpretation or threshold_source (device or guard_policy).
        recommended_step:
          type: string
          description: >-
            Technical next-step guidance; clients localize recommendations by
            condition code.
        first_seen_at:
          type: string
          format: date-time
        last_seen_at:
          type: string
          format: date-time
        resolved_at:
          type: string
          format: date-time
          description: >-
            Present only after fresh evidence resolves the episode; absence
            means active, including when later fields are missing.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - INTERNAL_ERROR
                - NOT_FOUND
                - BAD_REQUEST
                - UNAUTHORIZED
                - FORBIDDEN
                - CONFLICT
                - VALIDATION_ERROR
                - RATE_LIMITED
                - SERVICE_UNAVAILABLE
                - METHOD_NOT_ALLOWED
            message:
              type: string
            details:
              description: Additional error context (validation errors, etc.)
    DriveHealthUnavailableError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              const: INTERNAL_ERROR
            message:
              type: string
            details:
              type: object
              properties:
                reason_code:
                  type: string
                  const: drive_health_persistence_unavailable
                retryable:
                  type: boolean
                  const: true
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    DriveHealthUnavailable:
      description: >
        Drive evidence cannot be read because persistence is unavailable or its

        read failed. When persistence is not configured, details.reason_code is

        drive_health_persistence_unavailable and details.retryable is true.

        Authentication and hosted organization scope are checked before this
        error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DriveHealthUnavailableError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        OIDC/JWKS bearer token. Self-hosted defaults to Pocket ID; SaaS uses
        Auth0 through the edge. PocketBase JWT is legacy migration compatibility
        only.

````

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