---
title: "UpdateControlPlaneRequest"
url: "https://seriousmonkeybusiness.shermett.me/apis/konnect-control-planes-2/versions/cdbfd644-3e35-4ab1-acfb-99cb9b2d34ed/schemas/UpdateControlPlaneRequest"
---

> Full API specification: https://seriousmonkeybusiness.shermett.me/apis/konnect-control-planes-2/versions/cdbfd644-3e35-4ab1-acfb-99cb9b2d34ed.md

# UpdateControlPlaneRequest

The request schema for the update control plane request.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
components:
  schemas:
    ProxyURLs:
      description: Array of proxy URLs associated with reaching the data-planes
        connected to a control-plane.
      type: array
      items:
        $ref: "#/components/schemas/ProxyURL"
      format: set
      example:
        - host: example.com
          port: 443
          protocol: https
      title: ProxyURLs
    Labels:
      description: Labels to facilitate tagged search on control planes. Keys must be
        of length 1-63 characters, and cannot start with 'kong', 'konnect',
        'mesh', 'kic', or '_'.
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      title: Labels
    ProxyURL:
      description: Proxy URL associated with reaching the data-planes connected to a
        control-plane.
      type: object
      properties:
        host:
          description: Hostname of the proxy URL.
          type: string
        port:
          description: Port of the proxy URL.
          type: integer
        protocol:
          description: Protocol of the proxy URL.
          type: string
      example:
        host: example.com
        port: 443
        protocol: https
      additionalProperties: false
      required:
        - host
        - port
        - protocol
      title: ProxyURL
    UpdateControlPlaneRequest:
      description: The request schema for the update control plane request.
      type: object
      properties:
        name:
          description: The name of the control plane.
          type: string
          example: Test Control Plane
        description:
          description: The description of the control plane in Konnect.
          type: string
          example: A test control plane for exploration.
        auth_type:
          description: The auth type value of the cluster associated with the Runtime Group.
          type: string
          example: pinned_client_certs
          enum:
            - pinned_client_certs
            - pki_client_certs
        proxy_urls:
          $ref: "#/components/schemas/ProxyURLs"
        labels:
          $ref: "#/components/schemas/Labels"
      additionalProperties: false
      title: UpdateControlPlaneRequest
```