From aa0caa8b8cd9c5e279f625956057241c38be9d74 Mon Sep 17 00:00:00 2001
From: Thomas Kaul <4159106+dtslvr@users.noreply.github.com>
Date: Sat, 3 Oct 2026 22:39:25 +0200
Subject: [PATCH] Update documentation

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index b9352e3bd3..aa4a55e86d 100644
--- a/README.md
+++ b/README.md
@@ -193,6 +193,8 @@ You can get the _Bearer Token_ via `POST http://localhost:3333/api/v1/auth/anony
 
 ### Health Check (experimental)
 
+The endpoint checks the connection to the database and to _Redis_. It is suitable as the readiness probe of an orchestrator (e.g. `readinessProbe` in _Kubernetes_) and as the `healthcheck` in _Docker Compose_.
+
 #### Request
 
 `GET http://localhost:3333/api/v1/health`
@@ -211,6 +213,28 @@ You can get the _Bearer Token_ via `POST http://localhost:3333/api/v1/auth/anony
 }
 ```
 
+### Liveness Probe (experimental)
+
+The endpoint answers without a check of the database or _Redis_. It is suitable as the liveness probe of an orchestrator (e.g. `livenessProbe` in _Kubernetes_), so that an outage of a dependency does not restart the container.
+
+#### Request
+
+`GET http://localhost:3333/api/v1/health/liveness`
+
+**Info:** No Bearer Token is required for liveness probe
+
+#### Response
+
+##### Success
+
+`200 OK`
+
+```
+{
+  "status": "OK"
+}
+```
+
 ### Import Portfolio Data
 
 #### Prerequisites