Skip to content

Preview a cluster upgrade path

GET
/clusters/{cluster_id}/upgrade-path-preview
curl --request GET \
  --url 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/upgrade-path-preview?to=26.5.5' \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta'

Walks every version from the cluster’s current one to to without starting anything, and reports the steps and the blockers. allowed tells whether a start request with the same force would be accepted. Refuses with 409 Conflict for the same cluster states as starting a path.

Required scope: clusters:read

cluster_id
required
string format: uuid
to
required

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

string
>= 1 characters <= 20 characters /^[0-9]+\.[0-9]+(\.[0-9]+)?$/

Example

26.5.5
force
boolean
API-Version
required
string
Allowed values: 2026-06-01.beta

The request has succeeded.

Media typeapplication/json

An upgrade path walked without starting it.

object
from_version
required

Version the cluster runs now.

string
>= 1 characters <= 20 characters /^[0-9]+\.[0-9]+(\.[0-9]+)?$/
target_version
required

Requested target version.

string
>= 1 characters <= 20 characters /^[0-9]+\.[0-9]+(\.[0-9]+)?$/
force
required

Whether force was assumed for this preview.

boolean
allowed
required

Whether a request with these values would start. false when any blocker is not accepted.

boolean
steps
required

Every version the cluster would move through, in order.

Array<object>

One version a cluster moves through on an upgrade path.

object
version
required

Version of this step.

string
>= 1 characters <= 20 characters /^[0-9]+\.[0-9]+(\.[0-9]+)?$/
state
required

State of this step. One of: pending, running, done, failed, skipped. Cancelling a path leaves the step in progress as it is and marks every step that had not started skipped.

string
is_major_change
required

Whether moving onto this version crosses a major version boundary.

boolean
has_breaking_changes
required

Whether moving onto this version crosses recorded breaking changes.

boolean
blockers
required

Everything that blocks the path. A blocker with overridable: true is accepted when force is set.

Array<object>

A reason a version on an upgrade path cannot be taken.

object
version
required

The blocking version.

string
>= 1 characters <= 20 characters /^[0-9]+\.[0-9]+(\.[0-9]+)?$/
kind
required

Why the version blocks the path. breaking_change and major_jump are accepted with force. extension (an installed extension has no compatible build for the step, or a TideCloak cluster has any extension) and inactive_version (the version is inactive or quarantined) are never overridden.

string
overridable
required

Whether force accepts this blocker.

boolean
detail
required

Human-readable detail.

string
extensions

Extensions behind an extension blocker.

Array<string>
breaking_changes

Titles of the breaking changes behind a breaking_change blocker.

Array<string>

Example

{
  "from_version": "26.5.5",
  "target_version": "26.5.5",
  "steps": [
    {
      "version": "26.5.5"
    }
  ],
  "blockers": [
    {
      "version": "26.5.5"
    }
  ]
}

The server could not understand the request due to invalid syntax.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Access is unauthorized.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

The server cannot find the requested resource.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

The request conflicts with the current state of the server.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Client error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}
Retry-After
integer
RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer
X-RateLimit-Limit-Second
integer
X-RateLimit-Remaining-Second
integer
X-RateLimit-Limit-Minute
integer
X-RateLimit-Remaining-Minute
integer
X-RateLimit-Limit-Hour
integer
X-RateLimit-Remaining-Hour
integer
X-RateLimit-Limit-Day
integer
X-RateLimit-Remaining-Day
integer

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}