Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/AndrewwCO/Panahashi-Backend/llms.txt

Use this file to discover all available pages before exploring further.

The health check endpoint is publicly accessible and returns the current status of the Panahashi Backend server. It requires no authentication and is useful for uptime monitoring and deployment readiness checks.

GET /health

Auth required: No
curl http://localhost:8080/health
Response:
{
  "status": "ok",
  "service": "panahashi-backend",
  "version": "1.0.0"
}
status
string
Always "ok" when the server is running.
service
string
Service identifier: "panahashi-backend".
version
string
Current API version.
Use this endpoint as a readiness probe in your container orchestration setup to ensure the server is ready before routing traffic.

Build docs developers (and LLMs) love