Skip to main content

​
Endpoint

GET /api/ping
Simple health check endpoint that confirms the server is running and responding to requests.

​
Response

​
message
string
Always returns "pong" when the server is healthy

​
Status codes

  • 200: Server is healthy and responding

​
Example request

curl https://api.example.com/api/ping

​
Example response

{
  "message": "pong"
}

​
Notes

  • No authentication required
  • Use this endpoint for:
    • Server health monitoring
    • Uptime checks
    • Connection testing
    • Load balancer health probes
  • Always returns 200 status if the server is running

Build docs developers (and LLMs) love

Get started for freeTalk to us