---
title: "Health Check"
method: GET
path: "/health"
tags: ["Runtime"]
---

# Health Check

`GET /health`

Health check endpoint for monitoring and load balancers.

Returns ``status: "ok"`` only when an agent is registered and
``/agent/*`` will accept requests. Returns ``status: "degraded"`` with
``agent_ready: false`` when no agent is configured — e.g. standalone
admin-only mode after an ``assemble_engine_config`` error, or the
pre-onboarding wizard state. When ``app.state.boot_error`` is set by
the standalone's assembly failure handler, it is surfaced as ``reason``
so operators can diagnose without grepping logs.

## Response `200`

Successful Response

- HealthResponse — Response shape for ``/health``. ``reason`` is only emitted when an assembly failure handler set ``app.state.boot_error``; the route uses ``response_model_exclude_unset`` so the field stays absent (not ``null``) on the happy path.
  - `status` 'ok' | 'degraded', required
  - `service` string, required
  - `version` string, required
  - `agent_ready` boolean, required
  - `agent_name` string, nullable, required
  - `reason` string, nullable

---

[API](https://skmtc.net/idun-group/apis/idun-agent-engine-server.md) · [All operations](https://skmtc.net/idun-group/apis/idun-agent-engine-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/idun-group/idun-agent-engine-server/versions/8909cd73cc1c/schema)
