SIsignal18
ClusterMaintenance

Trigger a rolling action on a cluster

Changed on

Triggers one of: restart, reprov, upgrade, jobs-upgrade. reprov and upgrade are long-running and return 202 Accepted immediately; the operation runs in the background.

post/api/clusters/{clusterName}/actions/rolling/{action}

Request

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

Path parameters

clusterNamestring required

Cluster Name

action'restart' | 'reprov' | 'upgrade' | 'jobs-upgrade' required

Rolling action

Query parameters

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

upgrade only: the release to move to, a method of the image list: patch (default: the declared prov-db-image resolved by the list), next-minor, next-lts, next-major, last-lts, previous-minor, previous-major (downgrades), version

versionstring

upgrade with target=version: the release or line to move to

Headers

Authorizationstring required

Insert your access token

Response

Action triggered successfully

string required

Changes