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

# Availability, downtime episodes and daily state, derived from the transition timeline

> A projection over the append-only server transition timeline rather than a sampler: every episode is bounded by two recorded transitions and carries the reason codes they were written with. The response publishes its own accounting vocabulary, so a reader can see which connection states were counted as downtime without reading the source.



## OpenAPI

````yaml /techstack/reference/api/openapi.yaml get /api/v1/monitor/availability
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/availability:
    get:
      tags:
        - Metrics
      summary: >-
        Availability, downtime episodes and daily state, derived from the
        transition timeline
      description: >-
        A projection over the append-only server transition timeline rather than
        a sampler: every episode is bounded by two recorded transitions and
        carries the reason codes they were written with. The response publishes
        its own accounting vocabulary, so a reader can see which connection
        states were counted as downtime without reading the source.
      operationId: getAvailabilityReport
      parameters:
        - name: window
          in: query
          required: false
          schema:
            type: string
            enum:
              - 24h
              - 7d
              - 30d
              - 90d
            default: 30d
          description: Closed set; an unbounded window would be a denial-of-service knob.
        - name: server_id
          in: query
          required: false
          schema:
            type: string
          description: Scope the report to one server, for the server detail page.
      responses:
        '200':
          description: Availability report for the window
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AvailabilityReport'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    AvailabilityReport:
      type: object
      required:
        - window
        - start
        - end
        - uptime_ratio
        - observed_seconds
        - down_seconds
        - servers
        - accounting
      properties:
        window:
          type: string
          enum:
            - 24h
            - 7d
            - 30d
            - 90d
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        uptime_ratio:
          type:
            - number
            - 'null'
          description: >-
            up / (up + down) over observed time only. Null when the window
            contains no observed time - "no evidence" and "zero percent" are
            different statements.
        observed_seconds:
          type: integer
          format: int64
        down_seconds:
          type: integer
          format: int64
        mttr_seconds:
          type:
            - integer
            - 'null'
          format: int64
          description: >-
            Mean duration of episodes that ended. An ongoing outage never
            shortens it.
        closed_episodes:
          type: integer
        by_cause:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityCause'
        servers:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityServer'
        accounting:
          $ref: '#/components/schemas/AvailabilityAccounting'
    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.
    AvailabilityCause:
      type: object
      required:
        - reason_code
        - seconds
        - episodes
      properties:
        reason_code:
          type: string
          description: The reason the opening transition recorded, or `unrecorded`.
        seconds:
          type: integer
          format: int64
        episodes:
          type: integer
    AvailabilityServer:
      type: object
      required:
        - server_id
        - uptime_ratio
        - observed_seconds
        - down_seconds
        - episodes
        - days
      properties:
        server_id:
          type: string
        name:
          type: string
        uptime_ratio:
          type:
            - number
            - 'null'
        observed_seconds:
          type: integer
          format: int64
        down_seconds:
          type: integer
          format: int64
        episodes:
          type: array
          items:
            $ref: '#/components/schemas/AvailabilityEpisode'
        days:
          type: array
          items:
            type: object
            required:
              - day
              - state
            properties:
              day:
                type: string
                format: date
              state:
                type: string
                description: Worst state observed that UTC day; empty means no observation.
    AvailabilityAccounting:
      type: object
      required:
        - up
        - down
        - unobserved
      description: >-
        How each connection state was counted. `stale` is downtime: the agent
        stopped reporting, so service cannot be confirmed, and the conservative
        reading is the honest one for an availability figure. `pending` and
        `connecting` leave the denominator entirely - a node that never
        connected is not having an outage.
      properties:
        up:
          type: array
          items:
            type: string
        down:
          type: array
          items:
            type: string
        unobserved:
          type: array
          items:
            type: string
    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.)
    AvailabilityEpisode:
      type: object
      required:
        - server_id
        - started_at
        - seconds
        - ongoing
        - state
      properties:
        server_id:
          type: string
        server_name:
          type: string
        started_at:
          type: string
          format: date-time
        ended_at:
          type: string
          format: date-time
          description: >-
            Absent while the outage is ongoing; never backfilled from the window
            edge.
        seconds:
          type: integer
          format: int64
        ongoing:
          type: boolean
        state:
          type: string
          description: Worst connection state the episode reached.
        trigger_reason:
          type: string
        trigger_source:
          type: string
        recovery_reason:
          type: string
        recovery_source:
          type: string
        evidence_ref:
          type: string
  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'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: Required control-plane persistence or dependency is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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.