Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/farojas85/fast-rest-api/llms.txt

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

The /health endpoint confirms the API is running and accepting requests. It is a lightweight, unauthenticated probe designed for load balancer health checks, Kubernetes liveness probes, and uptime monitoring dashboards. No credentials are required and no database queries are performed — the response is returned directly by the FastAPI application layer.

​
Endpoint

PropertyValue
MethodGET
Path/health
AuthNone required
Tags(root-level — not mounted under /api/v1)

​
Response

A successful probe returns HTTP 200 OK with a JSON body confirming service availability.
PropertyValue
HTTP Status200 OK
Content-Typeapplication/json
{
  "status": "ok",
  "message": "API is running 🚀"
}

​
Example

Send a GET request to /health with curl: 
curl http://localhost:8000/health
Expected response: 
{"status": "ok", "message": "API is running 🚀"}

​
Source

The route is registered directly on the root FastAPI application instance in src/main.py: 
@app.get("/health", summary="Health Check")
async def health_check():
    return JSONResponse(content={"status": "ok", "message": "API is running 🚀"})
Because /health is mounted at the application root (not behind the /api/v1 router prefix), it is always reachable regardless of which versioned routers are active. This makes it safe to use as both a liveness and a readiness probe in containerised deployments.

Build docs developers (and LLMs) love

Get started for freeTalk to us