API reference · Schema
ClusterMember
objectstringrequiredAlways `cluster_member`: the type of this object
One of
cluster_memberrankintegerrequiredIts rank: 0 is the head
hostnamestringrequiredIts name, resolvable on every member
addressstringrequiredIts fixed private address on the cluster’s network
statestringrequiredstarting | running | failed (its container exited or could not start; nothing restarts it) | host_lost | stopped | deleted
One of
startingrunningfailedhost_loststoppeddeletedstate_reasonstring | nullrequiredMachine-readable cause the host reported, when there is one
host_idstringrequiredThe host it was placed on (opaque; members with the same value share a host)
simulated_gpusbooleanrequiredIts host advertises simulated GPUs (development only)
started_atstring (date-time) | nullrequiredWhen its current run started (null when not running)
How to open a shell on it through the SSH gateway (present when reading one cluster)
ShowHide 5 fields of
sshuserstringrequiredSSH user name (the member’s own identity)
hoststringrequiredSSH gateway host
portintegerrequiredSSH gateway port
commandstringrequiredReady-to-run ssh command (uses one of the project’s SSH keys)
known_hostsarray of stringrequiredLines for ~/.ssh/known_hosts pinning the host keys
{
"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"
]
}
}