Skip to main content
GET
/
v1
/
health
Health Check
curl --request GET \
  --url https://api.example.com/v1/health
Check if the API service is running and accessible.

​
Parameters

None

​
Authentication

Not required

​
Response

{
  "status": "healthy",
  "api_version": "v1",
  "version": "0.13.0"
}

​
Response Fields

FieldTypeDescription
statusstringHealth status of the service (always "healthy" if responding)
api_versionstringCurrent API version
versionstringApplication version number

​
Example Usage

curl http://localhost:8000/v1/health

# Or with HTTPS
curl https://your-domain.com:8000/v1/health

​
Use Cases

  • Health monitoring: Check if the service is operational
  • Load balancer checks: Verify service availability
  • Deployment validation: Confirm successful service startup
  • Network connectivity: Test basic API accessibility