Hanzo
OpenapiVisor

Adds a node pool to one of the caller org's clusters and answers 201 with the…

Adds a node pool to one of the caller org's clusters and answers 201 with the created pool.

POST /v1/visor/clusters/{clusterId}/pools

Addresshttps://api.hanzo.ai/v1/visor/clusters/{clusterId}/pools
MethodPOST
OperationcreateNodePool
AuthAuthorization: Bearer $HANZO_API_KEY

Adds a node pool to one of the caller org's clusters and answers 201 with the created pool. Only the CreateNodePoolSpec fields are forwarded; owner/provider/clusterId ride in the query exactly as Visor expects them.

Request

9 fields, body application/json (required).

FieldInTypeRequiredDescription
clusterIdpathstringyesClusterID is the cluster to add the pool to, from the URL path.
autoScalebodybooleanAutoScale turns the provider's cluster autoscaler on for this pool.
clusterIdbodystringClusterID is the cluster to add the pool to, from the URL path.
countbodyintegerCount is how many nodes the pool starts with.
maxNodesbodyintegerMaxNodes is the ceiling the autoscaler may not grow the pool past, and so the bound on what this pool can spend.
minNodesbodyintegerMinNodes is the floor the autoscaler may not shrink the pool below.
namebodystringName is the pool's name.
providerbodystringProvider is the cloud the cluster lives on (e.g.
sizebodystringSize is the provider size slug for each node (e.g.

Response

StatusBodyMeaning
200nodePoolViewok

200 body — 7 fields.

FieldInTypeAlwaysDescription
autoScalebodybooleanAutoScale reports whether the provider's cluster autoscaler owns this pool's size, moving Count between MinNodes and MaxNodes as workloads demand.
countbodyintegerCount is how many nodes the pool has right now.
maxNodesbodyintegerMaxNodes is the ceiling the autoscaler will not grow the pool past, and so the bound on what this pool can cost.
minNodesbodyintegerMinNodes is the floor the autoscaler will not shrink the pool below.
namebodystringName is the pool's name as the provider knows it.
poolIdbodystringPoolID is the provider's id for the pool — the value the scale and delete routes address it by.
sizebodystringSize is the provider size slug every node in the pool runs at ("s-4vcpu-8gb", "gpu-h100x8-640gb").

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