Skip to main content

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, no X-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:
Use the actual response from your running API as the source of truth; do not assume that this example is the exact response.

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.
A successful health check confirms that the endpoint responded. It does not necessarily confirm that the database, blockchain RPC, worker, or webhook delivery is healthy unless the endpoint explicitly checks those dependencies.

Troubleshooting

  1. Confirm that YOUR_API_HOST is replaced with your deployed Vaayu API host.
  2. Open the endpoint in a browser or call it with curl.
  3. If the request fails, review your hosting provider’s deployment and runtime logs.
  4. If the API responds but a specific feature fails, test that feature’s endpoint separately.