[FR] Provide health check api

[hugogu]

So that nginx or docker or k8s could conduct health check with it. Home page works but not perfect, a health check api is suppose to return structured response with details on its inner components' health status.

For sourcebot, it might include DB status and Filesystem remaining space information.

[hugogu]

Found it already exists, path is '/api/health', closing the issue.

[brendan-kellam]

@cursoragent Open a PR with the health api documented

[cursor]

I've successfully documented the health check API and prepared everything for the PR. Here's what was completed:

Changes Made

Created comprehensive documentation for the existing /api/health endpoint:

• New documentation file at docs/docs/api/healthCheck.mdx with detailed information about the endpoint
• Added practical usage examples for Docker Compose, Kubernetes, and Nginx integration
• Included response format and usage notes

Updated documentation navigation:

• Added new "API Reference" section to docs/docs.json
• Health Check documentation now appears in the docs site under API Reference

Commit and branch:

• Created commit: docs: Add health check API documentation
• Pushed to branch: cursor/health-api-documentation-1ef3
• 121 lines added across 2 files

The branch has been pushed successfully. The PR creation encountered a permissions issue with the GitHub CLI in this environment, but the branch is ready at:
https://github.com/sourcebot-dev/sourcebot/tree/cursor/health-api-documentation-1ef3

The remote environment should handle automatic PR creation, or you can create it manually from the GitHub UI using the pushed branch.

---

 

_{Learn more about Cursor Agents}