> ## Documentation Index > Fetch the complete documentation index at: https://www.latitude.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update an LKS cluster > Renames a cluster, edits its description, or upgrades the control plane. At least one of `name`, `description` or `kubernetes_version` must be provided. Setting a newer `kubernetes_version` consents to a control-plane upgrade; the value must be a patch listed by `GET /lks/available_versions` with `available_for_upgrade: true` and must not be lower than the current one. Node pools are upgraded separately and must never run a patch newer than the control plane. The cluster must be idle: a cluster that is provisioning, updating, scaling, upgrading, paused or deleting rejects the request with 409. ## OpenAPI ````yaml https://spec.speakeasy.com/latitude/latitude/latitude-sh-api-with-code-samples patch /lks/clusters/{id} openapi: 3.0.1 info: title: Latitude.sh API version: '2023-06-01' description: >- The Latitude.sh API is a RESTful API to manage your Latitude.sh account. It allows you to perform the same actions as the Latitude.sh dashboard. servers: - url: https://api.latitude.sh variables: latitude_api_key: default: - url: http://api.latitude.sh variables: latitude_api_key: default: security: [] tags: - name: API keys - name: Baselines (Preview) description: >- Preview. Available to teams with the `baselines_api` feature flag. The shape of these endpoints may change before general availability. - name: Billing - name: Elastic Ips - name: Events - name: Firewalls - name: IP Addresses - name: Managed Databases description: Managed database instances (PostgreSQL, ClickHouse) - name: Kubernetes Clusters - name: LKS - name: Marketplace apps - name: Operating Systems - name: Plans - name: Public Networks - name: Private Networks - name: Projects - name: Regions - name: Roles - name: SSH Keys - name: Servers - name: Block Storage - name: Filesystem Storage - name: Object Storage - name: Tags - name: Teams - name: Team members - name: Traffic - name: User data - name: User profile - name: VPN Sessions - name: Virtual machines - name: Virtual machine backups - name: Virtual machine restores paths: /lks/clusters/{id}: patch: tags: - LKS summary: Update an LKS cluster description: > Renames a cluster, edits its description, or upgrades the control plane. At least one of `name`, `description` or `kubernetes_version` must be provided. Setting a newer `kubernetes_version` consents to a control-plane upgrade; the value must be a patch listed by `GET /lks/available_versions` with `available_for_upgrade: true` and must not be lower than the current one. Node pools are upgraded separately and must never run a patch newer than the control plane. The cluster must be idle: a cluster that is provisioning, updating, scaling, upgrading, paused or deleting rejects the request with 409. operationId: update-lks-cluster parameters: - name: id in: path required: true description: 'The cluster ID (format: `lksc_`).' schema: type: string requestBody: required: true content: application/json: examples: Rename: value: data: type: lks_clusters attributes: name: production-eu UpgradeControlPlane: value: data: type: lks_clusters attributes: kubernetes_version: 1.37.2 schema: $ref: '#/components/schemas/update_lks_cluster' application/vnd.api+json: examples: Rename: value: data: type: lks_clusters attributes: name: production-eu UpgradeControlPlane: value: data: type: lks_clusters attributes: kubernetes_version: 1.37.2 schema: $ref: '#/components/schemas/update_lks_cluster' responses: '200': description: OK content: application/vnd.api+json: examples: Upgrading: value: data: id: lksc_pRMLydp0dQKr1 type: lks_clusters attributes: name: production description: '' project_id: proj_6059EqYkOQj8p site: DAL2 status: upgrading message: upgrading the cluster reason: Upgrading control_plane_endpoint: https://lksc-prmlydp0dqkr1.lks.latitude.sh:6443 kubeconfig_url: /lks/clusters/lksc_pRMLydp0dQKr1/kubeconfig kubernetes_version: 1.36.3 platform_version: lks-v1.36.3-002 network: pod_cidrs: - 10.0.0.0/12 service_cidrs: - 10.96.0.0/15 node_cidrs: - 10.16.0.0/21 created_at: '2026-09-01T12:00:00Z' updated_at: '2026-09-01T12:18:00Z' schema: $ref: '#/components/schemas/lks_cluster' '403': description: Forbidden content: application/vnd.api+json: examples: InsufficientPermissions: summary: The member role cannot perform this action value: errors: - code: USER_AUTHORIZATION_ERROR title: User Authorization Error detail: You are not authorized to perform this action. status: '403' meta: {} schema: $ref: '#/components/schemas/error_object' '404': description: Not Found content: application/vnd.api+json: examples: ClusterNotFound: summary: Unknown cluster, or a cluster owned by another team value: errors: - code: NOT_FOUND title: Cluster Not Found detail: Cluster 'lksc_pRMLydp0dQKr1' not found status: '404' meta: {} schema: $ref: '#/components/schemas/error_object' '409': description: >- Conflict — the cluster is not in an admissible state for this operation content: application/vnd.api+json: examples: OperationInProgress: summary: >- Another operation is still running (`provisioning`, `updating`, `scaling`, `upgrading`) value: errors: - code: OPERATION_IN_PROGRESS title: Operation In Progress detail: operation in progress status: '409' meta: {} ResourcePaused: value: errors: - code: RESOURCE_PAUSED title: Resource Paused detail: this cluster is paused status: '409' meta: {} ResourceDeleting: value: errors: - code: RESOURCE_DELETING title: Resource Deleting detail: this cluster is being deleted status: '409' meta: {} schema: $ref: '#/components/schemas/error_object' '422': description: Unprocessable Entity content: application/vnd.api+json: examples: DowngradeNotAllowed: value: errors: - code: DOWNGRADE_NOT_ALLOWED title: Downgrade Not Allowed detail: >- Downgrade not allowed: the cluster is on Kubernetes 1.36.3, requested 1.36.1 status: '422' meta: {} VersionNotAvailable: value: errors: - code: VERSION_NOT_AVAILABLE title: Version Not Available detail: Kubernetes 1.39.0 is not available for upgrade status: '422' meta: {} EmptyPayload: value: errors: - code: VALIDATION_ERROR title: Validation Error detail: >- at least one of name, description or kubernetes_version must be provided status: '422' schema: $ref: '#/components/schemas/error_object' '502': description: Bad Gateway — NetBox is temporarily unavailable content: application/vnd.api+json: examples: UpstreamServiceError: value: errors: - code: UPSTREAM_SERVICE_ERROR title: Bad Gateway detail: NetBox is temporarily unavailable. Please try again. status: '502' meta: {} schema: $ref: '#/components/schemas/error_object' security: - Bearer: [] x-codeSamples: - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tlatitudeshgosdk \"github.com/latitudesh/latitudesh-go-sdk\"\n\t\"github.com/latitudesh/latitudesh-go-sdk/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := latitudeshgosdk.New(\n latitudeshgosdk.WithSecurity(os.Getenv(\"LATITUDESH_BEARER\")),\n )\n\n res, err := s.Lks.UpdateLksCluster(ctx, \"\", components.UpdateLksCluster{\n Data: components.UpdateLksClusterData{\n Type: components.UpdateLksClusterTypeLksClusters,\n Attributes: &components.UpdateLksClusterAttributes{\n Name: latitudeshgosdk.Pointer(\"production-eu\"),\n },\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.LksCluster != nil {\n // handle response\n }\n}" components: schemas: update_lks_cluster: type: object properties: data: type: object properties: type: type: string enum: - lks_clusters attributes: type: object description: >- At least one of name, description or kubernetes_version must be provided. properties: name: type: string description: type: string maxLength: 200 kubernetes_version: type: string pattern: ^\d+\.\d+\.\d+$ example: 1.37.2 description: >- Setting a newer patch consents to a control-plane upgrade. Must not be lower than the current patch (422 DOWNGRADE_NOT_ALLOWED) required: - type required: - data lks_cluster: type: object properties: data: $ref: '#/components/schemas/lks_cluster_data' error_object: type: object properties: errors: type: array items: type: object properties: code: type: string nullable: true status: type: string title: type: string detail: type: string source: type: object properties: pointer: type: string parameter: type: string meta: type: object lks_cluster_data: type: object properties: id: type: string example: lksc_pRMLydp0dQKr1 type: type: string enum: - lks_clusters attributes: type: object properties: name: type: string description: type: string nullable: true project_id: type: string nullable: true site: type: string nullable: true status: type: string nullable: true description: Lifecycle state (open enum, sourced from NetBox/controller) example: provisioning message: type: string nullable: true reason: type: string nullable: true description: Machine-readable status reason (open enum) control_plane_endpoint: type: string nullable: true kubeconfig_url: type: string nullable: true kubernetes_version: type: string nullable: true example: 1.36.3 platform_version: type: string nullable: true example: lks-v1.36.3-002 network: type: object description: >- Configured cluster CIDRs. Always present: the ranges are columns on the cluster with platform defaults. properties: pod_cidrs: type: array items: type: string service_cidrs: type: array items: type: string node_cidrs: type: array items: type: string created_at: type: string nullable: true updated_at: type: string nullable: true securitySchemes: Bearer: type: apiKey name: Authorization in: header ````