Skip to content

Cancel a cluster upgrade path

POST
/clusters/{cluster_id}/upgrade-paths/{path_id}/cancel
curl --request POST \
  --url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/upgrade-paths/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta'

Stops an active path. The step in progress finishes, the remaining steps are skipped, and the path shows cancelled. reached_version is the version at the moment of the cancel; it is not updated if the step in progress then finishes. Returns 409 Conflict when the path already ended.

Required scope: clusters:write

cluster_id
required
string format: uuid
path_id
required
string format: uuid
API-Version
required
string
Allowed values: 2026-06-01.beta

The request has succeeded.

Media typeapplication/json

An upgrade path of a cluster.

object
id
required

Unique upgrade path identifier.

string
cluster_id
required

Cluster the path belongs to.

string format: uuid
from_version
required

Version the cluster ran when the path was requested.

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

Version the cluster should end on.

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

When each step runs.

string
Allowed values: now maintenance_window
force
required

Whether breaking changes and major jumps were accepted.

boolean
status
required

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.

string
reached_version
required

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.

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

Version of the step in progress. Absent when no step is running. The version the cluster runs is reached_version.

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

Every step of the path, 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
failure_reason

Why the path stopped. Present when status is failed.

string
created_at
required

When the path was requested.

string format: date-time
finished_at

When the path completed, failed or was cancelled. Absent while it is active.

string format: date-time

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.

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"
}