GET
/
healthz
Get health status of the API and cluster
curl --request GET \
  --url https://api.example.com/healthz
{
  "status": "<string>",
  "api": {
    "api_version": "<string>"
  },
  "boxes": {
    "pending": 1,
    "running": 1,
    "stopped": 1,
    "total": 1,
    "unknown": 1
  },
  "errors": [
    "<string>"
  ],
  "host": {
    "cpu": {
      "cores": 1,
      "load_avg_1": 123,
      "load_avg_15": 123,
      "load_avg_5": 123
    },
    "memory": {
      "available_bytes": 1,
      "total_bytes": 1,
      "used_bytes": 1,
      "used_percent": 123
    },
    "storage": {
      "available_bytes": 1,
      "path": "<string>",
      "total_bytes": 1,
      "used_bytes": 1,
      "used_percent": 123
    },
    "storage_mounts": [
      {
        "available_bytes": 1,
        "path": "<string>",
        "total_bytes": 1,
        "used_bytes": 1,
        "used_percent": 123
      }
    ]
  },
  "kubernetes": {
    "nodes": [
      {
        "cpu_allocatable": "<string>",
        "cpu_capacity": "<string>",
        "memory_allocatable_bytes": 1,
        "memory_capacity_bytes": 1,
        "name": "<string>",
        "pods_allocatable": 1,
        "pods_capacity": 1,
        "pods_running": 1,
        "ready": true
      }
    ],
    "total_pods_capacity": 1,
    "total_pods_running": 1
  },
  "namespace": "<string>"
}

Response

200 - application/json

Health status

status
string
required
api
object
boxes
object
errors
string[] | null
host
object
kubernetes
object
namespace
string | null