---
title: "request for upgrade TiDB cluster"
method: POST
path: "/clusters/:clusterId/upgrade"
tags: ["cluster upgrade"]
---

# request for upgrade TiDB cluster

`POST /clusters/:clusterId/upgrade`

request for upgrade TiDB cluster

## Path parameters

- `clusterId` string, required

## Request body

- ClusterUpgradeClusterReq
  - `configs` StructsClusterUpgradeVersionConfigItem[]
    - `instanceType` string, required
    - `name` string, required
    - `paramId` string, required
    - `value` string, required
  - `targetVersion` string, required
  - `upgradeType` 'in-place' | 'migration', required
  - `upgradeWay` 'offline' | 'online'

## Response `200`

OK

- object
  - `code` integer
  - `data` object
    - `clusterId` string
    - `workFlowId` string — Asynchronous task workflow ID
  - `message` string

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

## Changes

- **2022-03-07** `e9e75c7c2edb` — 1 breaking, 1 info
  - api path removed without deprecation
  - endpoint added

[Change history](https://skmtc.dev/pingcap/apis/em-ui-api/changes/clusters/:clusterId/upgrade/post.md)

---

[API](https://skmtc.dev/pingcap/apis/em-ui-api.md) · [All operations](https://skmtc.dev/pingcap/apis/em-ui-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pingcap/em-ui-api/revisions/e9e75c7c2edb/schema)