feat: add /health endpoint for container orchestration#2810
Merged
hayescode merged 3 commits intoChainlit:mainfrom Mar 5, 2026
Merged
feat: add /health endpoint for container orchestration#2810hayescode merged 3 commits intoChainlit:mainfrom
hayescode merged 3 commits intoChainlit:mainfrom
Conversation
Add a GET /health endpoint that returns {"status": "ok"} for use
with container health checks (Azure Docker, Kubernetes, etc.).
Br1an67
requested review from
asvishnyakov,
hayescode and
sandangel
as code owners
dosubot
bot
added
the
size:S
dosubot
bot
added
backend
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
hayescode
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add a
GET /healthendpoint that returns{"status": "ok"}.Closes #1866
Why
Container orchestration platforms (Azure Docker apps, Kubernetes, etc.) need a health check endpoint to monitor service availability. The existing
HEAD /endpoint isn't suitable as it requires parsing HTML and doesn't follow health check conventions.Changes
backend/chainlit/server.py: AddedGET /healthroutebackend/tests/test_server.py: Added test for the health endpointTesting
test_health_checkverifies 200 response with correct JSON bodySummary by cubic
Add a GET /health endpoint that returns {"status":"ok"} for container health checks. Enables simple liveness/readiness probes for Kubernetes, Azure Docker apps, and similar platforms. Addresses #1866.
Written for commit df8e1bf. Summary will update on new commits.