---
title: "Plan a rolling upgrade"
method: GET
path: "/api/clusters/{clusterName}/actions/rolling/upgrade/plan"
tags: ["ClusterMaintenance"]
---

# Plan a rolling upgrade

`GET /api/clusters/{clusterName}/actions/rolling/upgrade/plan`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `Authorization`

Resolves the target with the image list of the configurator (patch, next-minor, next-lts, next-major, last-lts, version) from the line the nodes run and describes the steps, the target release, what prov-db-image declares afterwards and the warnings. Nothing is changed.

## Path parameters

- `clusterName` string, required

## Query parameters

- `target` 'patch' | 'next-minor' | 'next-lts' | 'next-major' | 'last-lts' | 'previous-minor' | 'previous-major' | 'version'
- `version` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- ClusterRollingUpgradePlan
  - `cluster` string
  - `currentImage` string: prov-db-image as declared
  - `currentIsLTS` boolean
  - `currentLine` string
  - `currentRelease` string: the release the service definitions carry (prov-db-docker-img-resolved)
  - `declaredAfter` string: prov-db-image after the upgrade
  - `flavor` string
  - `imageList` string
  - `mechanic` string: "upgrade" (restart on the new image) or "reprov" (provision again + reseed)
  - `nodes` object[]
  - `orchestrator` string
  - `order` string[]
  - `status` string
  - `steps` string[]
  - `target` string
  - `targetImage` string: the real release, repo:x.y.z
  - `targetIsLTS` boolean
  - `targetLine` string
  - `warnings` string[]

## Other responses

- `400`: Target not resolvable
- `403`: No valid ACL
- `500`: No cluster

## Changes

- **2026-10-12** `d4e4c5013f0c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/changes/api/clusters/:clusterName/actions/rolling/upgrade/plan/get.md)

---

[API](https://skmtc.dev/signal18/apis/signal-18-dashboard-api.md) - [All operations](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/revisions/8ee8a1e31294?raw)