Create clusters — POST /v1/compute/k8s/clusters

Provisions a DOKS cluster for the caller's org and answers 201.

POST /v1/compute/k8s/clusters

Addresshttps://api.hanzo.ai/v1/compute/k8s/clusters
MethodPOST
OperationcreateKubernetesCluster
AuthAuthorization: Bearer $HANZO_API_KEY

Provisions a DOKS cluster for the caller's org and answers 201. ADMIN-GATED — a SuperAdmin, or an OrgAdmin of the caller's own org — because provisioning spends real infrastructure on the house account. The request is validated at this boundary, then Visor owns provisioning and the hanzo-org ownership tag.

Request

7 fields, body application/json (required).

FieldInTypeRequiredDescription
namebodystring—Name is the cluster's name.
nodePoolbodyobject—NodePool is the ONE pool the cluster is born with — a cluster with no nodes runs nothing, so it is not optional.
nodePool.countbodyinteger (int64)—
nodePool.namebodystring—
nodePool.sizebodystring—
regionbodystring—Region is the provider region slug (e.g. "nyc3").
versionbodystring—Version is the Kubernetes version slug; empty takes the provider default.

Response

StatusBodyMeaning
200compute.clusterViewok
defaultproblem-detailsrefused

200 body — 19 fields.

FieldInTypeAlwaysDescription
amdGpubodyinteger (int64)—AmdGPU is the same count for amd.com/gpu: AMD accelerators across the BYO cluster's nodes, as of the attach.
createdAtbodystring—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.
doClusterIdbodystring—DoClusterID carries the SAME id as DoksClusterID.
doksClusterIdbodystring—DoksClusterID is the provider's own id for the cluster, and the value the /v1/compute/k8s/clusters/:id routes take.
kindbodystring—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.
namebodystring—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.
nodeCountbodyinteger (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.
nodePoolsbodycompute.nodePoolView[]—NodePools is the authoritative node inventory — every pool, each with its own size and count.
nodePools[].autoScalebodyboolean—AutoScale reports whether the provider's cluster autoscaler owns this pool's size, moving Count between MinNodes and MaxNodes as workloads demand.
nodePools[].countbodyinteger (int64)—Count is how many nodes the pool has right now.
nodePools[].maxNodesbodyinteger (int64)—MaxNodes is the ceiling the autoscaler will not grow the pool past, and so the bound on what this pool can cost.
nodePools[].minNodesbodyinteger (int64)—MinNodes is the floor the autoscaler will not shrink the pool below.
nodePools[].namebodystring—Name is the pool's name as the provider knows it.
nodePools[].poolIdbodystring—PoolID is the provider's id for the pool — the value the scale and delete routes address it by.
nodePools[].sizebodystring—Size is the provider size slug every node in the pool runs at ("s-4vcpu-8gb", "gpu-h100x8-640gb").
nodeSizebodystring—NodeSize is a display convenience: the size slug of the FIRST pool.
nvidiaGpubodyinteger (int64)—NvidiaGPU is how many NVIDIA accelerators the cluster's nodes advertise, the sum of nvidia.com/gpu allocatable across them.
regionbodystring—Region is the provider region slug for a managed cluster.
statusbodystring—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.

Failure carries the platform error shape — see Errors.

Examples

hanzo compute k8s clusters create
import { Configuration, ComputeApi } from 'hanzoai';

const api = new ComputeApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.createKubernetesCluster({ name: "<name>", nodePool: {"count":0,"name":"<name>","size":"<size>"} });
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).create_kubernetes_cluster(name="<name>", node_pool={"count":0,"name":"<name>","size":"<size>"})
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ComputeAPI.CreateKubernetesCluster(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::create_kubernetes_cluster(&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).createKubernetesCluster();
curl -X POST https://api.hanzo.ai/v1/compute/k8s/clusters \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "name": "<name>",
       "nodePool": {
         "count": 0,
         "name": "<name>",
         "size": "<size>"
       }
     }'

Tool compute, op createKubernetesCluster — 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": "createKubernetesCluster",
           "input": {
             "name": "<name>",
             "nodePool": {
               "count": 0,
               "name": "<name>",
               "size": "<size>"
             }
           }
         }
       }
     }'

Compute API · All Hanzo APIs · Interactive reference

Was this page useful?