OpenapiCompute
List nodes
Returns every DOKS worker node in the org's clusters as a machine — the SAME set the fleet folds in (managedMachines), exposed directly under the k8s…
GET /v1/compute/k8s/nodes
| Address | https://api.hanzo.ai/v1/compute/k8s/nodes |
| Method | GET |
| Operation | listKubernetesNodes |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns every DOKS worker node in the org's clusters as a machine — the SAME set the fleet folds in (managedMachines), exposed directly under the k8s noun. House account (hanzo-org cluster tag) + BYOC, deduped by Visor.
Request
GET /v1/compute/k8s/nodes takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | compute.nodeList | ok |
default | problem-details | refused |
200 body — 29 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
nodes | body | compute.machineView[] | — | Nodes is one row per worker node, in the SAME machineView shape the machines surface emits — a node IS a machine. |
nodes[].agent | body | string | — | Agent is the cloud Agent this machine runs, lifted out of the binding so a list reads without following one. |
nodes[].binding | body | compute.agentBinding | — | |
nodes[].binding.agentName | body | string | — | AgentName is the cloud Agent (/v1/agent) this machine runs — the agent a message to the bot is actually run against. |
nodes[].binding.botVersion | body | string | — | BotVersion pins the @hanzo/bot runtime version the machine runs. |
nodes[].binding.createdTime | body | string | — | CreatedTime is when the binding was first made. |
nodes[].binding.machineId | body | string | — | MachineId is the bound machine as vm addresses it, owner-qualified ("<org>/<machine>"). |
nodes[].binding.message | body | string | — | Message is vm's human-readable detail on Status ("machine provisioning; @hanzo/bot runtime not yet confirmed") — the reason behind the state, not a second… |
nodes[].binding.name | body | string | — | Name is the binding's own key, which is the machine's id: a machine hosts at most one agent, so the binding is named for it. |
nodes[].binding.org | body | string | — | Org is the Hanzo tenant the binding belongs to. |
nodes[].binding.owner | body | string | — | Owner is the tenant vm filed the binding under, resolved from the ?owner it was called with — which is the caller's validated org and never a body field. |
nodes[].binding.provider | body | string | — | Provider is the cloud the bound machine runs on, carried here so a bindings list says where each bot lives without a second read per machine. |
nodes[].binding.publicIp | body | string | — | PublicIp is the bound machine's public address as vm recorded it on the binding. |
nodes[].binding.status | body | string | — | Status is the binding's lifecycle in VM's OWN words — "Pending" while the machine provisions and the runtime is unconfirmed, "running" once vm has confirmed… |
nodes[].binding.updatedTime | body | string | — | UpdatedTime is when vm last reconciled it — the age of Status. |
nodes[].createdTime | body | string | — | CreatedTime is when the machine came into being: the provider's own creation timestamp for a Visor machine, passed through in whatever form it states it, and… |
nodes[].gpu | body | string | — | GPU names the accelerators this machine holds ("H100", or "2× NVIDIA GB10" for a BYO machine reporting a matched pair). |
nodes[].id | body | string | — | ID addresses this machine on the /v1/compute/machines/:id routes: the org-scoped NAME Visor keys a machine by, falling back to the provider id for a machine… |
nodes[].image | body | string | — | Image is the OS image the machine booted from, as the provider names it. |
nodes[].mem | body | string | — | Mem is system RAM rendered for a human ("8 GB"), not a number to compute with. |
nodes[].name | body | string | — | Name is the label to show a human — Visor's displayName, or the machine name when it carries none. A BYO machine's is its hostname. |
nodes[].os | body | string | — | Os is the operating system on the machine — Visor's record for a provisioned one, the host's own report (linux, darwin, windows) for a BYO one. |
nodes[].privateIp | body | string | — | PrivateIp is the address on the provider's own network, reachable from the org's other machines in the same region. |
nodes[].provider | body | string | — | Provider is the cloud that runs the machine ("digitalocean"), or "byo" for one the operator dialed in with hanzo link. |
nodes[].publicIp | body | string | — | PublicIp is the internet-facing address the provider assigned. |
nodes[].region | body | string | — | Region is the provider region slug ("sfo3"), or the zone when the provider reports only that. |
nodes[].status | body | string | — | Status is the lifecycle state in the PROVIDER's own words ("active", "running", "off"), passed through rather than mapped onto a vocabulary of ours. |
nodes[].type | body | string | — | Type is the provider SIZE SLUG the machine runs at ("s-2vcpu-4gb", "gpu-h100x8-640gb") — the value a launch asks for, and what Vcpu/Mem/GPU are read out of… |
nodes[].vcpu | body | integer (int64) | — | Vcpu is logical cores — the provider's own cpuSize when that is a clean integer, else the count read out of the size slug (4 from "s-4vcpu-8gb"). |
Failure carries the platform error shape — see Errors.
Examples
hanzo compute k8s nodesimport { Configuration, ComputeApi } from 'hanzoai';
const api = new ComputeApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listKubernetesNodes();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ComputeApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ComputeApi(client).list_kubernetes_nodes()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ComputeAPI.ListKubernetesNodes(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, compute_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = compute_api::list_kubernetes_nodes(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ComputeApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new ComputeApi(client).listKubernetesNodes();curl https://api.hanzo.ai/v1/compute/k8s/nodes \
-H "Authorization: Bearer $HANZO_API_KEY"Tool visor, op listKubernetesNodes — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "visor",
"arguments": {
"op": "listKubernetesNodes",
"input": {}
}
}
}'How is this guide?