Sign in

v1

latestOpenAPI 3.1.02026-07-1711039.2 KB
Clusters

Update a cluster

Update cluster metadata and/or create a new cluster version. Changing zkvm_version_id or vk_path creates a new cluster version.

patch/clusters/{id}

Path parameters

idinteger required

Cluster ID (index)

Request body

namestring

Human-readable name. Main display name in the UI

num_gpusinteger

Number of GPUs in the cluster. Determines if cluster is multi-GPU (>1) or single-GPU (1).

hardware_descriptionstring

Free-form text description of the cluster's hardware for display in the UI

is_activeboolean

Whether the cluster is active and can receive proofs

zkvm_version_idinteger

ID of the zkVM version. Changing this creates a new cluster version. Visit ZKVMs to view all available zkVMs and their IDs.

vk_pathstring

Verification key path for the cluster version

Example request

{
  "name": "ZKnight-01",
  "num_gpus": 8,
  "hardware_description": "8x NVIDIA H100 80GB GPUs, AMD EPYC 9654 96-Core Processor",
  "is_active": true,
  "zkvm_version_id": 1,
  "vk_path": "/path/to/vk"
}

Response

Cluster updated successfully

successboolean required