---
title: "Update a virtual cluster"
method: PUT
path: "/gateway_manager/v1/virtual-clusters/{id}"
tags: ["Gateway Manager"]
---

# Update a virtual cluster

`PUT /gateway_manager/v1/virtual-clusters/{id}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/gateway_manager/v1/virtual-clusters/{id}`
- Auth: none declared

Updates the definition of a virtual cluster. Only include fields that should change.

## Path parameters

- `id` string, required

## Request body

- object
  - `payload` GatewayManagerV1VirtualClustersIdPutRequestBodyContentApplicationJsonSchemaPayload
    - `cluster_id` string
    - `description` string
    - `enabled` boolean
    - `readonly` boolean
    - `primary_cluster_id` string
    - `backup_cluster_ids` string[]
    - `groups` string[]

## Response `200`

Result of updating the virtual cluster

- GatewayManagerUpdateVirtualClusterResponse200
  - `state` string
  - `result` GatewayManagerV1VirtualClustersIdPutResponsesContentApplicationJsonSchemaResult
  - `message` string

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Gateway Manager` added
  - api tag `gatewayManager` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/gateway_manager/v1/virtual-clusters/:id/put.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)