Skip to main content
The system endpoints give you a real-time view of the MirrorNeuron cluster. Use the health endpoint for simple liveness probes, and the summary endpoint to inspect all connected nodes, their executor pool utilization, and the list of currently active jobs.

​
Health check

GET /api/v1/health
A lightweight liveness check that confirms the API server is running. This endpoint performs no cluster queries and always responds immediately.
This is the right endpoint to use in load balancer health checks, Kubernetes liveness probes, and readiness gates.

​
Example request

curl -s http://localhost:4000/api/v1/health

​
Response

200 OK
​
status
string
required
Always "ok" when the server is reachable.
{
  "status": "ok"
}

​
System summary

GET /api/v1/system/summary
Returns a combined overview of all cluster nodes and their executor pool state, alongside a list of currently active jobs. This is equivalent to calling MirrorNeuron.cluster_overview/1 from Elixir.

​
Example request

curl -s http://localhost:4000/api/v1/system/summary

​
Response

200 OK
​
nodes
object[]
required
Array of node summaries for every member of the connected BEAM cluster.
​
jobs
object[]
required
Array of active job summaries known to the cluster at the time of the request.
{
  "nodes": [
    {
      "name": "mn1@192.168.4.183",
      "connected_nodes": ["mn1@192.168.4.183"],
      "self?": true,
      "scheduler_hint": "cluster_member",
      "executor_pools": {
        "default": {
          "capacity": 2,
          "available": 1,
          "in_use": 1,
          "queued": 0,
          "active": 1
        }
      }
    }
  ],
  "jobs": [
    {
      "job_id": "prime_sweep_40_workers-...",
      "status": "running"
    }
  ]
}
500 Internal Server Error — returned if the cluster overview query fails. 
{
  "error": "..."
}