List cluster upgrade paths
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/upgrade-paths';
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-paths \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'Returns the cluster’s upgrade paths, newest first and capped at the 20 most recent. The first entry with status pending or running is the active path, so a path started from the dashboard or elsewhere can be read and cancelled without knowing its id.
Required scope: clusters:read
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The request has succeeded.
An upgrade path of a cluster.
object
Unique upgrade path identifier.
Cluster the path belongs to.
Version the cluster ran when the path was requested.
Version the cluster should end on.
When each step runs.
Whether breaking changes and major jumps were accepted.
Lifecycle of the path. One of: pending, running, completed, failed, cancelled. pending and running hold the cluster: no second path or manual upgrade is accepted.
Last version the cluster confirmed running. When the path is cancelled it is the version at the moment of the cancel and is not updated if the step in progress then finishes.
Version of the step in progress. Absent when no step is running. The version the cluster runs is reached_version.
Every step of the path, 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.
Why the path stopped. Present when status is failed.
When the path was requested.
When the path completed, failed or was cancelled. Absent while it is active.
Example
[
{
"from_version": "26.5.5",
"target_version": "26.5.5",
"timing": "now",
"reached_version": "26.5.5",
"in_progress_version": "26.5.5",
"steps": [
{
"version": "26.5.5"
}
]
}
]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"
}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"
}