ClusterClient.update

cluster = cluster_client.update(
    "dev",
    name="Development",
    description="Development workloads",
)

def ClusterClient.update(
    cluster_or_slug: Cluster | str,
    name: str | None = None,
    description: str | None = None,
) -> Cluster

Update a cluster.

Parameters

cluster_or_slug

Cluster | str

The cluster or cluster slug to update.

name

str | None

Optional new display name for the cluster. If omitted, the display name is unchanged.

description

str | None

Optional new cluster description. Pass an empty string to clear the description. If omitted, the description is unchanged.

The updated cluster object, including its slug, display name, description, whether it can be deleted, and deployed workflows.

cluster = cluster_client.update(
    "dev",
    name="Development",
    description="Development workloads",
)