---
title: "Patch parts of control plane"
url: "https://nov18-dev.movespot.fyi/apis/konnect-mesh-control-plane-manager-0/versions/09f86219-cde6-4c57-9f6a-7d3dfbc494a1/operations/patch-mesh-control-plane"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-mesh-control-plane-manager-0/versions/09f86219-cde6-4c57-9f6a-7d3dfbc494a1.md

# Patch parts of control plane

`PATCH` `/mesh/control-planes/{cpId}`

Operation ID: `patch-mesh-control-plane`

Update an individual control plane.

## Path parameters

- `cpId` (string, uuid, required) - Id of the Konnect resource

## Request body (required)

Content types: `application/json`

## Responses

- `200` - A response to updating a control plane.
- `400` - Validation Error
- `401` - Unauthorized Error
- `403` - Permission denied
- `404` - Not found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Mesh Control Plane manager
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /mesh/control-planes/{cpId}:
    parameters:
      - name: cpId
        in: path
        description: Id of the Konnect resource
        required: true
        schema:
          type: string
          format: uuid
        example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
    patch:
      operationId: patch-mesh-control-plane
      summary: Patch parts of control plane
      description: Update an individual control plane.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateMeshControlPlaneRequest"
            examples:
              Example Request Body:
                $ref: "#/components/examples/UpdateMeshControlPlaneRequestExample"
      responses:
        "200":
          $ref: "#/components/responses/UpdateMeshControlPlaneResponse"
        "400":
          $ref: "#/components/responses/UpdateMeshControlPlaneValidationError"
        "401":
          $ref: "#/components/responses/MeshControlPlaneUnauthorizedError"
        "403":
          $ref: "#/components/responses/MeshControlPlaneForbiddenError"
        "404":
          $ref: "#/components/responses/MeshControlPlaneNotFoundError"
      tags:
        - Mesh
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  schemas:
    UpdateMeshControlPlaneRequest:
      description: a payload to update parts of the control plane
      type: object
      properties:
        name:
          $ref: "#/components/schemas/MeshControlPlaneName"
        description:
          type: string
          example: A control plane to handle traffic on development environment.
          maxLength: 250
        labels:
          $ref: "#/components/schemas/MeshControlPlaneLabels"
      title: UpdateMeshControlPlaneRequest
    MeshControlPlaneName:
      description: The name of the control plane.
      type: string
      example: Test control plane
      maxLength: 100
      minLength: 1
      pattern: ^[a-z0-9A-Z]{1}.*$
    MeshControlPlaneLabels:
      description: Labels to facilitate tagged search on control planes. Keys must be
        of length 1-63 characters.
      type: object
      example:
        test: "true"
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z\-\.\_]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
        nullable: true
      maxProperties: 10
      nullable: true
      title: Labels
    MeshControlPlane:
      description: a control plane
      type: object
      properties:
        id:
          description: ID of the control plane.
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
          readOnly: true
        name:
          $ref: "#/components/schemas/MeshControlPlaneName"
        description:
          $ref: "#/components/schemas/MeshControlPlaneDescription"
        labels:
          $ref: "#/components/schemas/MeshControlPlaneLabels"
        features:
          $ref: "#/components/schemas/MeshControlPlaneFeatures"
        created_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
          readOnly: true
        updated_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
          readOnly: true
      required:
        - id
        - name
        - updated_at
        - created_at
      title: ControlPlane
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    MeshControlPlaneDescription:
      type: string
      example: A control plane to handle traffic on development environment.
      maxLength: 250
    MeshControlPlaneFeatures:
      type: array
      items:
        $ref: "#/components/schemas/MeshControlPlaneFeature"
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    MeshControlPlaneFeature:
      description: >
        Features to be enabled in the control plane. Currently only defaults are
        supported.
      type: object
      properties:
        type:
          type: string
          enum:
            - MeshCreation
            - HostnameGeneratorCreation
        hostnameGeneratorCreation:
          $ref: "#/components/schemas/MeshControlPlaneFeatureHostnameGenerationCreation"
        meshCreation:
          $ref: "#/components/schemas/MeshControlPlaneFeatureMeshCreation"
      required:
        - type
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    MeshControlPlaneFeatureHostnameGenerationCreation:
      properties:
        enabled:
          type: boolean
      required:
        - enabled
    MeshControlPlaneFeatureMeshCreation:
      properties:
        enabled:
          type: boolean
      required:
        - enabled
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    UpdateMeshControlPlaneRequestExample:
      value:
        name: Test Control Plane
        description: A test control plane for exploration.
        labels:
          test: "true"
    ControlPlaneExample:
      value:
        id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
        name: Test Control Plane
        description: A test control plane for exploration.
        labels:
          test: "true"
        created_at: 2022-11-04T20:10:06.927Z
        updated_at: 2022-11-04T20:10:06.927Z
  responses:
    UpdateMeshControlPlaneResponse:
      description: A response to updating a control plane.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/MeshControlPlane"
          examples:
            Update Control Plane Response:
              $ref: "#/components/examples/ControlPlaneExample"
    UpdateMeshControlPlaneValidationError:
      description: Validation Error
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
          examples:
            Empty Field:
              value:
                status: 400
                title: Bad Request
                type: https://kongapi.info/konnect/bad-request
                instance: konnect:trace:6480643114111646299
                detail: ""
                invalid_parameters:
                  - field: name
                    reason: Value is not nullable
                    source: ""
    MeshControlPlaneUnauthorizedError:
      description: Unauthorized Error
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            Invalid token:
              value:
                status: 401
                type: https://kongapi.info/konnect/unauthenticated
                title: Unauthenticated
                instance: konnect:trace:4497422055499297627
                detail: A valid token is required
    MeshControlPlaneForbiddenError:
      description: Permission denied
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            Invalid token:
              value:
                status: 403
                type: https://kongapi.info/konnect/unauthorized
                title: Forbidden
                instance: konnect:trace:881615734723181661
                detail: Permission denied
    MeshControlPlaneNotFoundError:
      description: Not found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            Invalid token:
              value:
                status: 404
                type: https://kongapi.info/konnect/not-found
                title: Not Found
                instance: konnect:trace:369660938739689085
                detail: The requested requested entity was not found was not found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
