Skip to content
Hayonix

API reference · Schema

ClusterMember

  • objectstringrequired

    Always `cluster_member`: the type of this object

    One ofcluster_member

  • rankintegerrequired

    Its rank: 0 is the head

  • hostnamestringrequired

    Its name, resolvable on every member

  • addressstringrequired

    Its fixed private address on the cluster’s network

  • statestringrequired

    starting | running | failed (its container exited or could not start; nothing restarts it) | host_lost | stopped | deleted

    One ofstartingrunningfailedhost_loststoppeddeleted

  • state_reasonstring | nullrequired

    Machine-readable cause the host reported, when there is one

  • host_idstringrequired

    The host it was placed on (opaque; members with the same value share a host)

  • simulated_gpusbooleanrequired

    Its host advertises simulated GPUs (development only)

  • started_atstring (date-time) | nullrequired

    When its current run started (null when not running)

  • sshClusterMemberSshrequired

    How to open a shell on it through the SSH gateway (present when reading one cluster)

    Show 5 fields of ssh
    • userstringrequired

      SSH user name (the member’s own identity)

    • hoststringrequired

      SSH gateway host

    • portintegerrequired

      SSH gateway port

    • commandstringrequired

      Ready-to-run ssh command (uses one of the project’s SSH keys)

    • known_hostsarray of stringrequired

      Lines for ~/.ssh/known_hosts pinning the host keys

Example
{
  "object": "cluster_member",
  "rank": 1,
  "hostname": "member-0",
  "address": "string",
  "state": "starting",
  "state_reason": "string",
  "host_id": "string",
  "simulated_gpus": true,
  "started_at": "2026-01-01T00:00:00.000Z",
  "ssh": {
    "user": "string",
    "host": "string",
    "port": 1,
    "command": "string",
    "known_hosts": [
      "string"
    ]
  }
}