Hanzo
OpenapiVisor

Returns one cluster's detail: node pools + worker nodes.

Returns one cluster's detail: node pools + worker nodes.

GET /v1/visor/k8s/clusters/{id}

Addresshttps://api.hanzo.ai/v1/visor/k8s/clusters/{id}
MethodGET
OperationgetKubernetesCluster
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one cluster's detail: node pools + worker nodes. Visor scopes the lookup to the org (a foreign or missing id resolves to not-found), so a tenant can never read another tenant's cluster by guessing an id.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the provider's DOKS cluster id.

Response

StatusBodyMeaning
200clusterDetailViewok

200 body — 34 fields.

FieldInTypeAlwaysDescription
amdGpubodyinteger
createdAtbodystring
doClusterIdbodystring
doksClusterIdbodystring
kindbodystring
namebodystring
nodeCountbodyinteger
nodePoolsbodynodePoolView[]
nodePools[].autoScalebodybooleanAutoScale reports whether the provider's cluster autoscaler owns this pool's size, moving Count between MinNodes and MaxNodes as workloads demand.
nodePools[].countbodyintegerCount is how many nodes the pool has right now.
nodePools[].maxNodesbodyintegerMaxNodes is the ceiling the autoscaler will not grow the pool past, and so the bound on what this pool can cost.
nodePools[].minNodesbodyintegerMinNodes is the floor the autoscaler will not shrink the pool below.
nodePools[].namebodystringName is the pool's name as the provider knows it.
nodePools[].poolIdbodystringPoolID is the provider's id for the pool — the value the scale and delete routes address it by.
nodePools[].sizebodystringSize is the provider size slug every node in the pool runs at ("s-4vcpu-8gb", "gpu-h100x8-640gb").
nodeSizebodystring
nodesbodymachineView[]Nodes is every worker node in the cluster, each in the same shape the machines surface uses — a node IS a machine, addressable by its own id.
nodes[].createdTimebodystringCreatedTime 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[].gpubodystringGPU names the accelerators this machine holds ("H100", or "2× NVIDIA GB10" for a BYO machine reporting a matched pair).
nodes[].idbodystringID addresses this machine on the /v1/visor/machines/:id routes: the org-scoped NAME Visor keys a machine by, falling back to the provider id for a machine that…
nodes[].imagebodystringImage is the OS image the machine booted from, as the provider names it.
nodes[].membodystringMem is system RAM rendered for a human ("8 GB"), not a number to compute with.
nodes[].namebodystringName 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[].osbodystringOs 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[].privateIpbodystringPrivateIp is the address on the provider's own network, reachable from the org's other machines in the same region.
nodes[].providerbodystringProvider is the cloud that runs the machine ("digitalocean"), or "byo" for one the operator dialed in with hanzo link.
nodes[].publicIpbodystringPublicIp is the internet-facing address the provider assigned.
nodes[].regionbodystringRegion is the provider region slug ("sfo3"), or the zone when the provider reports only that.
nodes[].statusbodystringStatus is the lifecycle state in the PROVIDER's own words ("active", "running", "off"), passed through rather than mapped onto a vocabulary of ours.
nodes[].typebodystringType 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[].vcpubodyintegerVcpu 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").
nvidiaGpubodyinteger
regionbodystring
statusbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Visor API · All Hanzo APIs · Interactive reference

How is this guide?

On this page