Health Check
Use the health-check endpoint to verify that the Vaayu API is reachable.Endpoint
GET /health
Authentication
This endpoint is intended to be a basic service-health check. If your deployed implementation does not require authentication, noX-API-Key header is needed.
Example request
Example response
The exact response depends on your deployed implementation. If your endpoint returns a simple health status, it may look like this:Interpreting the result
- Successful 2xx response: The API endpoint responded to the request.
- Connection failure or timeout: The service may be unavailable, starting up, or unreachable from your network.
- 5xx response: The server encountered an error while handling the request.
Troubleshooting
- Confirm that
YOUR_API_HOSTis replaced with your deployed Vaayu API host. - Open the endpoint in a browser or call it with
curl. - If the request fails, review your hosting provider’s deployment and runtime logs.
- If the API responds but a specific feature fails, test that feature’s endpoint separately.