> ## 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. # Exchange kombify Guard reach state with the control plane > kombify Guard reach. A Guard with a bound host key (access token plus proof) reports its kombify.me relay connection and hands over the host proof the control plane requested for its Connect registration; the answer is the reach document: the overall state, the relay target once kombify.me holds the binding for the current generation, and at most one outstanding proof request with the exact claims to sign. The document carries no credential. Legacy bearer Guards receive `needs_host_key`; deployments without a Cloud connection receive `disabled`. A failure downstream is recorded and reported on the server read model, never returned as an error to the Guard. ## OpenAPI ````yaml /techstack/reference/api/openapi.yaml post /api/v1/workers/{id}/reach 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": , "meta": { "total": int, "page": int, "per_page": int } }` **Error:** `{ "error": { "code": "", "message": "...", "details": } }` ## 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/workers/{id}/reach: post: tags: - Workers summary: Exchange kombify Guard reach state with the control plane description: >- kombify Guard reach. A Guard with a bound host key (access token plus proof) reports its kombify.me relay connection and hands over the host proof the control plane requested for its Connect registration; the answer is the reach document: the overall state, the relay target once kombify.me holds the binding for the current generation, and at most one outstanding proof request with the exact claims to sign. The document carries no credential. Legacy bearer Guards receive `needs_host_key`; deployments without a Cloud connection receive `disabled`. A failure downstream is recorded and reported on the server read model, never returned as an error to the Guard. operationId: exchangeWorkerReach parameters: - $ref: '#/components/parameters/resourceId' requestBody: required: false content: application/json: schema: type: object properties: relay: type: object required: - state properties: state: type: string enum: - connecting - connected - denied - stopped reason_code: type: string pattern: ^[a-z0-9_.-]{0,64}$ generation: type: integer format: int64 proofs: type: array maxItems: 4 items: type: object required: - audience - generation - proof properties: audience: type: string enum: - https://connect.kombify.io generation: type: integer format: int64 minimum: 1 proof: type: string maxLength: 4096 responses: '200': description: The reach document content: application/json: schema: $ref: '#/components/schemas/SuccessEnvelope' '401': description: Access token or proof not accepted '403': description: Identity revoked (guard_identity_revoked) '503': description: Reach is temporarily unavailable security: - runtimeAgentAuth: [] components: parameters: resourceId: name: id in: path required: true description: Resource ID schema: type: string schemas: SuccessEnvelope: type: object properties: data: description: Response payload meta: $ref: '#/components/schemas/ResponseMeta' 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. 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. runtimeAgentAuth: type: http scheme: bearer bearerFormat: TechStack-Runtime-Agent description: >- Runtime-agent credential bound to the exact tenant, placement, server, and worker identity. Signed, opaque, and explicit legacy compatibility tokens are validated fail-closed by the worker runtime. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.