gh-whamp-whamp-claude-tools-pocketbase-plugin/skills/pocketbase/references/api/api_health.md

Health API

Overview

The Health API provides system health checks, metrics, and status information.

Check Health Status

GET /api/health

Response:

{
  "code": 200,
  "data": {
    "status": "ok",
    "metrics": {
      "clients": 5,
      "requests": 1000,
      "errors": 2
    }
  }
}

Detailed Health Check

GET /api/health/detailed
Authorization: Bearer {admin_token}

Response:

{
  "status": "ok",
  "version": "0.20.0",
  "uptime": 3600,
  "database": {
    "status": "ok",
    "size": 1048576,
    "connections": 5
  },
  "cache": {
    "status": "ok",
    "hits": 100,
    "misses": 10
  },
  "metrics": {
    "active_connections": 5,
    "total_requests": 1000,
    "error_rate": 0.02
  }
}

Metrics

GET /api/metrics
Authorization: Bearer {admin_token}

---

Note: This is a placeholder file. See core/going_to_production.md for monitoring best practices.