Healthcheck Endpoint #2023

New Issue

OVERLORD · 2026-02-05T02:37:08+03:00

OVERLORD commented

2026-02-05 02:37:08 +03:00

Originally created by @modem7 on GitHub (Jan 10, 2021).

API Endpoint or Feature

A healthcheck endpoint where it returns an OK/200 if all is good.

Use-Case

Docker and Traefik both allow healthchecks to be performed, this is useful if there is a failure and the container needs rebooting/alerting that something isn't right.

Originally created by @modem7 on GitHub (Jan 10, 2021). #### API Endpoint or Feature A healthcheck endpoint where it returns an OK/200 if all is good. #### Use-Case Docker and Traefik both allow healthchecks to be performed, this is useful if there is a failure and the container needs rebooting/alerting that something isn't right.

OVERLORD added the 📖 Docs Update 🔩 API Request labels 2026-02-05 02:37:08 +03:00

OVERLORD closed this issue

2026-02-05 02:37:10 +03:00

OVERLORD commented

2026-02-05 02:37:14 +03:00

@ssddanbrown commented on GitHub (Jan 10, 2021):

Thanks for the request @modem7.

I'm thinking that this being part of the official API system may cause a lot more complexity than required (As you'd need to pass the right auth headers).

I think we could just add this as a publicly accessible, still JSON, endpoint. As long as we're not exposing anything private.
On request, We should probably perform:

Simple DB query to ensure connection.
Cache random value put/get check.

Return 200 status code unless any failure, in which case 500.

@ssddanbrown commented on GitHub (Jan 10, 2021): Thanks for the request @modem7. I'm thinking that this being part of the official API system may cause a lot more complexity than required (As you'd need to pass the right auth headers). I think we could just add this as a publicly accessible, still JSON, endpoint. As long as we're not exposing anything private. On request, We should probably perform: - Simple DB query to ensure connection. - Cache random value put/get check. Return 200 status code unless any failure, in which case 500.

OVERLORD commented

2026-02-05 02:37:18 +03:00

@modem7 commented on GitHub (Jan 10, 2021):

The publicly accessible endpoint would definitely be useful, that way we could also have it on loadbalancers with reverse proxies as well as docker/grafana etc.

@modem7 commented on GitHub (Jan 10, 2021): The publicly accessible endpoint would definitely be useful, that way we could also have it on loadbalancers with reverse proxies as well as docker/grafana etc.

OVERLORD commented

2026-02-05 02:37:20 +03:00

@ssddanbrown commented on GitHub (Jan 17, 2021):

Now included within 6eda1c1fb2, To be part of the next feature release (v0.32).

@ssddanbrown commented on GitHub (Jan 17, 2021): Now included within 6eda1c1fb28142d432bf0ca05d7eaba9bf16f0d0, To be part of the next feature release (v0.32).

OVERLORD referenced this issue

2026-02-05 10:20:56 +03:00

[PR #2023] [MERGED] fix Chinese translation error #5941

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#2023