Health & Status

Service health monitoring endpoints. Use these to verify API availability and check the current version.

2 endpoints

Guide

Use these endpoints to monitor API availability and verify the service version. They are unauthenticated and ideal for load balancer health checks, uptime monitoring dashboards, and deployment verification.

Health Check Integration

The health check endpoint returns a simple JSON response indicating the API is operational. Configure your monitoring tool to poll this endpoint at regular intervals.

Uptime monitoring example

Poll the health endpoint every 30 seconds

# Simple health check with curl
curl -s https://api.bluehive.com/v1/health | jq .
# Response: { "status": "ok" }

# Use in a monitoring script
while true; do
  STATUS=$(curl -s -o /dev/null -w "%{http_code}" https://api.bluehive.com/v1/health)
  if [ "$STATUS" != "200" ]; then
    echo "ALERT: API returned $STATUS at $(date)"
  fi
  sleep 30
done

Version Verification

After deployments, verify the API version matches your expected release. This is useful in CI/CD pipelines to confirm a rollout completed successfully.

Post-deployment check

Verify API version after deployment

curl -s https://api.bluehive.com/v1/version
# Response: { "version": "1.0.0" }