---
title: "Update cluster"
method: PATCH
path: "/api/v1/clusters/{id}"
tags: ["clusters"]
---

# Update cluster

`PATCH /api/v1/clusters/{id}`

Partially updates a cluster by its identifier. The code is immutable.

## Path parameters

- `id` string, uuid, required

## Request body

- ClusterUpdate
  - `name` string
  - `active` boolean
  - `description` string, nullable
  - `color` string, nullable
  - `metadata` object, nullable

## Response `200`

Cluster updated.

- ClusterUpdateResponse
  - `id` string, required
  - `code` string, required
  - `name` string, required
  - `description` string, nullable, required
  - `color` string, nullable, required
  - `active` boolean, required
  - `metadata` object, nullable, required
  - `created_at` string, required
  - `updated_at` string, required

## Other responses

- `400` — Request payload, query string, or path parameter failed validation.
- `401` — Authentication is missing, malformed, expired, or refers to a session that is no longer active.
- `403` — The caller is authenticated but lacks the required permission for this action.
- `404` — Cluster not found in the caller account.
- `422` — The payload passed schema validation but breaks a domain invariant.
- `500` — Unexpected server error. The response body never leaks internal details.

## Changes

- **2026-07-07** `a3b4750a505f` — 14 info
  - added the new optional request property `active`
  - added the new optional request property `color`
  - added the new optional request property `description`
  - added the new optional request property `metadata`
  - …10 more
- **2026-07-07** `84194c31ab85` — 9 breaking, 5 warning
  - removed the required property `active` from the response with the `200` status
  - removed the required property `code` from the response with the `200` status
  - removed the required property `color` from the response with the `200` status
  - removed the required property `created_at` from the response with the `200` status
  - …10 more

[Change history](https://skmtc.dev/kruzer-corp/apis/oms-api/changes/api/v1/clusters/:id/patch.md)

---

[API](https://skmtc.dev/kruzer-corp/apis/oms-api.md) · [All operations](https://skmtc.dev/kruzer-corp/apis/oms-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kruzer-corp/oms-api/revisions/38ef6e16a7a8/schema)