Health Check

Check API and service status.

GET /v1/health

Health Check

cURL

curl --request GET \
  --url https://api.example.com/v1/health

200

{
  "status": "<string>",
  "timestamp": "<string>",
  "checks": {}
}

Check the health of the API and its dependencies. No authentication required.

Response

status · string · required

Overall status: ok or degraded.

timestamp · string · required

Current server time (ISO 8601).

checks · object · required

Status of individual services.

Example

curl

curl https://api.stashfyle.com/v1/health

Response

{
  "status": "ok",
  "timestamp": "2024-01-15T10:30:00Z",
  "checks": {
    "database": { "status": "ok", "latency_ms": 12 },
    "storage": { "status": "ok", "latency_ms": 45 }
  }
}

Use Cases

• Uptime monitoring (Pingdom, UptimeRobot, etc.)
• Load balancer health checks
• CI/CD deployment verification