---
title: "Get cluster upgrade path"
method: GET
path: "/clusters/{cluster_id}/upgrade-path"
tags: ["Cluster Operations"]
---

# Get cluster upgrade path

`GET /clusters/{cluster_id}/upgrade-path`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/clusters/{cluster_id}/upgrade-path`
- Auth: API key in header `API-Key`

Returns the ordered sequence of versions the cluster must pass through to reach the latest available version.

Required scope: `clusters:read`

## Path parameters

- `cluster_id` string, uuid, required

## Headers

- `API-Version` '2026-06-01.beta', required

## Response `200`

The request has succeeded.

- ClusterUpgradePathItem[]
  - `version` string, required: Cluster version in semver format. Check the documentation for the latest supported versions.
  - `required` boolean, required: Whether this version must be visited as an intermediate step. `false` only for the cluster's current version.
  - `is_major_change` boolean, required: Whether this step crosses a major version boundary from the cluster's current version. Auto-upgrade never applies a major step on its own.
  - `breaking_change_count` integer, required: Number of breaking changes recorded for this version. Auto-upgrade never applies a version with a recorded breaking change on its own.

## Other responses

- `401`: Access is unauthorized.
- `404`: The server cannot find the requested resource.
- `429`: Client error
- `500`: Server error
- `501`: Server error

---

[API](https://skmtc.dev/skycloak/apis/skycloak-public-api.md) · [All operations](https://skmtc.dev/skycloak/apis/skycloak-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/skycloak/apis/skycloak-public-api/revisions/33a69e2ce35f?raw)