---
title: "Clusters.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.

# Clusters.Update

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

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

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

```go
func (*ClusterClient) Update(
    ctx context.Context,
    slug string,
    options ...cluster.UpdateOption,
) (*workflows.Cluster, error)
```

Update a cluster.

## Parameters

**slug**

type: string

The slug of the cluster to update.
**cluster.WithName(name string)**

type: cluster.UpdateOption

Optional new display name for the cluster.
**cluster.WithDescription(description string)**

type: cluster.UpdateOption

Optional new cluster description. Pass an empty string to clear the description.

## Returns

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

## Errors

**not_found**

type: cluster not found

The specified cluster does not exist.

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

```go
updatedCluster, err := client.Clusters.Update(ctx,
    "dev",
    cluster.WithName("Development"),
    cluster.WithDescription("Development workloads"),
)
```

Source: https://tilebox.com/docs/api-reference/go/workflows/Clusters.Update/index.mdx