---
title: "ClusterClient.update"
description: "Update a cluster."
image: "https://tilebox.com/images/tilebox-docs-social-preview.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://tilebox.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClusterClient.update

import { Fragment } from "astro/jsx-runtime";

import ApiReference from "@docs/components/ApiReference.astro";

import ParamField from "@docs/components/ParamField.astro";

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

Update a cluster.

## Parameters

**cluster_or_slug**

type: Cluster | str

The cluster or cluster slug to update.
**name**

type: str | None

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

type: str | None

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

## Returns

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

<h2 id="request-example">Usage example</h2>

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

Source: https://tilebox.com/docs/api-reference/python/tilebox.workflows/ClusterClient.update/index.mdx