List clusters — GET /v1/compute/k8s/clusters

Lists the org's DOKS clusters (Visor, house account) folded with the org's BYO clusters — ONE fleet cluster view under the unified k8s noun.

GET /v1/compute/k8s/clusters

Compute → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/compute/k8s/clusters`
Method	`GET`
Operation	`listKubernetesClusters`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Lists the org's DOKS clusters (Visor, house account) folded with the org's BYO clusters — ONE fleet cluster view under the unified k8s noun. A Visor outage is logged and skipped so a down optional provider never hides the BYO list.

Request

GET /v1/compute/k8s/clusters takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	compute.clusterList	ok
`default`	problem-details	refused

200 body — 23 fields.

Field	In	Type	Always	Description
`clusters`	body	compute.clusterView[]	—	Clusters is the merged fleet — kind "managed" for Visor-provisioned, "byo" for an attached kubeconfig.
`clusters[].amdGpu`	body	integer (int64)	—	AmdGPU is the same count for `amd.com/gpu`: AMD accelerators across the BYO cluster's nodes, as of the attach.
`clusters[].createdAt`	body	string	—	CreatedAt is when the cluster started existing: the earliest creation time among its pools for a managed cluster, and for a BYO one the RFC 3339 moment it was attached.
`clusters[].doClusterId`	body	string	—	DoClusterID carries the SAME id as DoksClusterID.
`clusters[].doksClusterId`	body	string	—	DoksClusterID is the provider's own id for the cluster, and the value the /v1/compute/k8s/clusters/:id routes take.
`clusters[].kind`	body	string	—	Kind says which of the two kinds of cluster this row is, and there are only two: "managed" — Visor provisioned it and Hanzo's account pays the provider — or "byo", an existing cluster the org attached by kubeconfig.
`clusters[].name`	body	string	—	Name is the cluster's name: the provider's for a managed cluster, and for a BYO one the lower-cased fleet name it was attached under — which is also how the detach route addresses it.
`clusters[].nodeCount`	body	integer (int64)	—	NodeCount is how many worker nodes the cluster has — the sum over its pools for a managed cluster, and for a BYO one the node count read off the cluster when it was attached.
`clusters[].nodePools`	body	compute.nodePoolView[]	—	NodePools is the authoritative node inventory — every pool, each with its own size and count.
`clusters[].nodePools[].autoScale`	body	boolean	—	AutoScale reports whether the provider's cluster autoscaler owns this pool's size, moving Count between MinNodes and MaxNodes as workloads demand.
`clusters[].nodePools[].count`	body	integer (int64)	—	Count is how many nodes the pool has right now.
`clusters[].nodePools[].maxNodes`	body	integer (int64)	—	MaxNodes is the ceiling the autoscaler will not grow the pool past, and so the bound on what this pool can cost.
`clusters[].nodePools[].minNodes`	body	integer (int64)	—	MinNodes is the floor the autoscaler will not shrink the pool below.
`clusters[].nodePools[].name`	body	string	—	Name is the pool's name as the provider knows it.
`clusters[].nodePools[].poolId`	body	string	—	PoolID is the provider's id for the pool — the value the scale and delete routes address it by.
`clusters[].nodePools[].size`	body	string	—	Size is the provider size slug every node in the pool runs at ("s-4vcpu-8gb", "gpu-h100x8-640gb").
`clusters[].nodeSize`	body	string	—	NodeSize is a display convenience: the size slug of the FIRST pool.
`clusters[].nvidiaGpu`	body	integer (int64)	—	NvidiaGPU is how many NVIDIA accelerators the cluster's nodes advertise, the sum of `nvidia.com/gpu` allocatable across them.
`clusters[].region`	body	string	—	Region is the provider region slug for a managed cluster.
`clusters[].status`	body	string	—	Status is the cluster's state: the provider's own word for a managed cluster ("running", "provisioning"), "unknown" when the provider stated none, and always "attached" for a BYO cluster — that one says the kubeconfig is on file, not that the cluster is reachable this second.
`degraded`	body	compute.sourceFailure[]	—	Degraded names any source that did not answer, so an empty Clusters means "you have none" only when this is absent.
`degraded[].reason`	body	string	—	Reason is a terse, log-safe summary — never the upstream's response body.
`degraded[].source`	body	string	—	Source is the dependency that failed, named as an operator names it.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo compute k8s clusters list

.ts

.py

.go

.rs

.java

import { Configuration, ComputeApi } from 'hanzoai';

const api = new ComputeApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listKubernetesClusters();

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_clusters()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ComputeAPI.ListKubernetesClusters(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_clusters(&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).listKubernetesClusters();

curl https://api.hanzo.ai/v1/compute/k8s/clusters \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool compute, op listKubernetesClusters — 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": "compute",
         "arguments": {
           "op": "listKubernetesClusters",
           "input": {}
         }
       }
     }'

Compute API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList gpus NextList nodes