Cluster Operations

Get cluster upgrade path

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

Required scope: clusters:read

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

Path parameters

cluster_idstring uuid required

Headers

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

Response

The request has succeeded.

versionstring required

Cluster version in semver format. Check the documentation for the latest supported versions.

requiredboolean required

Whether this version must be visited as an intermediate step. false only for the cluster's current version.

is_major_changeboolean 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_countinteger required

Number of breaking changes recorded for this version. Auto-upgrade never applies a version with a recorded breaking change on its own.

Example response

[
  {
    "version": "26.5.5"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.