Preview a cluster upgrade path
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/upgrade-path-preview?to=26.5.5';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Cluster version in semver format. Check the documentation for the latest supported versions.
Example
26.5.5Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The request has succeeded.
An upgrade path walked without starting it.
object
Version the cluster runs now.
Requested target version.
Whether force was assumed for this preview.
Whether a request with these values would start. false when any blocker is not accepted.
Every version the cluster would move through, in order.
One version a cluster moves through on an upgrade path.
object
Version of this step.
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.
Whether moving onto this version crosses a major version boundary.
Whether moving onto this version crosses recorded breaking changes.
Everything that blocks the path. A blocker with overridable: true is accepted when force is set.
A reason a version on an upgrade path cannot be taken.
object
The blocking version.
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.
Whether force accepts this blocker.
Human-readable detail.
Extensions behind an extension blocker.
Titles of the breaking changes behind a breaking_change blocker.
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.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is unauthorized.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
RFC 9457 Problem Details object.
object
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.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}