> For the complete documentation index, see [llms.txt](https://vectis.liesware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vectis.liesware.com/health.md).

# Health

## GET /healthz/startup

> Startup probe

```json
{"openapi":"3.1.0","info":{"title":"Vectis HTTP API","version":"v1"},"tags":[{"name":"Health"}],"servers":[{"url":"http://127.0.0.1:3000","description":"Local default server over HTTP"},{"url":"https://127.0.0.1:3000","description":"Local HTTPS server when VECTIS_MODE=prod"}],"paths":{"/healthz/startup":{"get":{"tags":["Health"],"summary":"Startup probe","responses":{"200":{"description":"Service startup state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartupHealthOutput"}}}},"default":{"$ref":"#/components/responses/Error"}}}}},"components":{"schemas":{"StartupHealthOutput":{"type":"object","required":["status","timestamp"],"properties":{"status":{"const":"started"},"timestamp":{"$ref":"#/components/schemas/Timestamp"}}},"Timestamp":{"type":"string","pattern":"^[0-9]+$"},"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/TextField"}}},"TextField":{"type":"string","minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F-\\x9F]+$"}},"responses":{"Error":{"description":"Public error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}
```

## GET /healthz/live

> Liveness probe

```json
{"openapi":"3.1.0","info":{"title":"Vectis HTTP API","version":"v1"},"tags":[{"name":"Health"}],"servers":[{"url":"http://127.0.0.1:3000","description":"Local default server over HTTP"},{"url":"https://127.0.0.1:3000","description":"Local HTTPS server when VECTIS_MODE=prod"}],"paths":{"/healthz/live":{"get":{"tags":["Health"],"summary":"Liveness probe","responses":{"200":{"description":"Service liveness state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveHealthOutput"}}}},"default":{"$ref":"#/components/responses/Error"}}}}},"components":{"schemas":{"LiveHealthOutput":{"type":"object","required":["status"],"properties":{"status":{"const":"ok"}}},"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/TextField"}}},"TextField":{"type":"string","minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F-\\x9F]+$"}},"responses":{"Error":{"description":"Public error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}
```

## Readiness probe

> Performs a lightweight storage check and returns current state counts.

```json
{"openapi":"3.1.0","info":{"title":"Vectis HTTP API","version":"v1"},"tags":[{"name":"Health"}],"servers":[{"url":"http://127.0.0.1:3000","description":"Local default server over HTTP"},{"url":"https://127.0.0.1:3000","description":"Local HTTPS server when VECTIS_MODE=prod"}],"paths":{"/healthz/ready":{"get":{"tags":["Health"],"summary":"Readiness probe","description":"Performs a lightweight storage check and returns current state counts.","responses":{"200":{"description":"Service readiness state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadyHealthOutput"}}}},"default":{"$ref":"#/components/responses/Error"}}}}},"components":{"schemas":{"ReadyHealthOutput":{"type":"object","required":["status","unsealed","storage","keys_loaded","routes_loaded"],"properties":{"status":{"const":"ready"},"unsealed":{"type":"boolean"},"storage":{"const":"ok"},"keys_loaded":{"type":"integer","minimum":0},"routes_loaded":{"type":"integer","minimum":0}}},"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/TextField"}}},"TextField":{"type":"string","minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F-\\x9F]+$"}},"responses":{"Error":{"description":"Public error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}
```