CovenDocs

Daemon health and contract handshake

1 min read

GET
/health

Response Body

Daemon is reachable and ready.

application/json
  1. response

Daemon health and contract handshake.

ok*boolean

Liveness flag. Always true when the response is delivered.

apiVersion*string

Named API contract version. Compare against coven.daemon.v1.

covenVersion*string

Daemon build identity: the release tag the binary was stamped with, including any git describe distance, commit, or -dirty suffix for a source build, or unknown when no version could be resolved. Treat it as an opaque build label; negotiate compatibility on apiVersion and capabilities.

capabilities*

Machine-readable capability flags. Additional fields may be added in v1; clients should ignore unknown keys.

daemon*|

Daemon process metadata, or null when unavailable.

hub?

Hub control-plane summary (role and node availability). Omitted when the response is built without store access.

curl -X GET 'http://localhost:3000/api/v1/health'
{  "ok": true,  "apiVersion": "coven.daemon.v1",  "covenVersion": "0.4.2",  "capabilities": {    "sessions": true,    "events": true,    "travel": true,    "scheduler": true,    "hub": true,    "executorDispatch": true,    "eventCursor": "sequence",    "structuredErrors": true,    "sessionPolicyContracts": [      "coven.session-policy.v1"    ]  },  "daemon": {    "pid": 12345,    "startedAt": "2026-05-09T12:00:00Z",    "socket": "/home/example/.coven/coven.sock"  }}
Was this page helpful?No

Last updated on