---
title: "Update Control Plane"
method: PATCH
path: "/v2/control-planes/{id}"
tags: ["Control Planes"]
---

# Update Control Plane

`PATCH /v2/control-planes/{id}`

Update an individual control plane.

## Request body

- UpdateControlPlaneRequest — The request schema for the update control plane request.
  - `name` string — The name of the control plane.
  - `description` string — The description of the control plane in Konnect.
  - `auth_type` 'pinned_client_certs' | 'pki_client_certs' — The auth type value of the cluster associated with the Runtime Group.
  - `proxy_urls` ProxyURL[] — Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
    - `host` string, required — Hostname of the proxy URL.
    - `port` integer, required — Port of the proxy URL.
    - `protocol` string, required — Protocol of the proxy URL.
  - `labels` Labels — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

## Response `200`

A response to updating a control plane.

- ControlPlane — The control plane object contains information about a Kong control plane.
  - `id` string, uuid, required — The control plane ID.
  - `name` string, required — The name of the control plane.
  - `description` string — The description of the control plane in Konnect.
  - `labels` Labels — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
  - `config` object, required — CP configuration object for related access endpoints.
    - `control_plane_endpoint` string, url, required — Control Plane Endpoint.
    - `telemetry_endpoint` string, url, required — Telemetry Endpoint.
    - `cluster_type` 'CLUSTER_TYPE_CONTROL_PLANE' | 'CLUSTER_TYPE_K8S_INGRESS_CONTROLLER' | 'CLUSTER_TYPE_CONTROL_PLANE_GROUP' | 'CLUSTER_TYPE_SERVERLESS', required — The ClusterType value of the cluster associated with the Control Plane.
    - `auth_type` 'pinned_client_certs' | 'pki_client_certs', required — The auth type value of the cluster associated with the Runtime Group.
    - `cloud_gateway` boolean, required — Whether the Control Plane can be used for cloud-gateways.
    - `proxy_urls` ProxyURL[] — Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
      - `host` string, required — Hostname of the proxy URL.
      - `port` integer, required — Port of the proxy URL.
      - `protocol` string, required — Protocol of the proxy URL.
  - `created_at` string, date-time, required — An ISO-8604 timestamp representation of control plane creation date.
  - `updated_at` string, date-time, required — An ISO-8604 timestamp representation of control plane update date.

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Permission denied
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

## Changes

- **2024-11-11** `08ead66e9ebb` — 2 breaking, 2 warning, 9 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - added `#/components/schemas/InvalidParameterMaximumLength` to the `allOf[subschema #2]/invalid_parameters/items/` response property `oneOf` list for the response status `400`
  - added the new `min` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMinimumLength]/rule` response property for the response status `400`
  - added the new `min_items` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMinimumLength]/rule` response property for the response status `400`
  - …9 more
- **2024-09-11** `be7c36317ba6` — 2 breaking
  - the `proxy_urls` request property type/format changed from `array`/`` to `array`/`set`
  - the `allOf[subschema #1: ControlPlaneSummary]/config/proxy_urls` response's property type/format changed from `array`/`` to `array`/`set` for status `200`

[Change history](https://skmtc.dev/kong/apis/konnect-api/changes/v2/control-planes/:id/patch.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/konnect-api/revisions/08ead66e9ebb/schema)