Skip to content

Commit 5b40f5c

Browse files
ivovfreakwriter
andauthored
docs: Add /healthz/readiness endpoint (n8n-io#2455)
Co-authored-by: Kate Mueller <[email protected]>
1 parent 58b44f8 commit 5b40f5c

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/hosting/logging-monitoring/monitoring.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,27 @@ contentType: howto
66

77
# Monitoring
88

9-
There are two API endpoints you can call to check the status of your instance: `/healthz` and `/metrics`.
9+
There are three API endpoints you can call to check the status of your instance: `/healthz`, `healthz/readiness`, and `/metrics`.
1010

1111
<!-- vale off -->
12-
## healthz
12+
## healthz and healthz/readiness
1313
<!-- vale on -->
14-
The `/healthz` endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It's available for both self-hosted and Cloud users.
14+
The `/healthz` endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It doesn't indicate DB status. It's available for both self-hosted and Cloud users.
1515

1616
Access the endpoint:
1717

1818
```
1919
<your-instance-url>/healthz
2020
```
2121

22+
The `/healthz/readiness` endpoint is similar to the `/healthz` endpoint, but it returns a HTTP status code of 200 if the DB is connected and migrated and therefore the instance is ready to accept traffic.
23+
24+
Access the endpoint:
25+
26+
```
27+
<your-instance-url>/healthz/readiness
28+
```
29+
2230

2331
## metrics
2432

0 commit comments

Comments
 (0)