Upgrade cluster

put

https://cluster.ip.address/v2/clusters/upgrade

Upgrade the software on the cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The parameters to upgrade the software on the cluster.

abortUpgradeOnChecksFailure

boolean

Defaults to true

Specifies if pre upgrade healthchecks failure will cause upgrade to be aborted. By default we abort upgrade if there are healthchecks failures .Cluster will stop the upgrade.and present the failures which need to be resolved before proceeding with upgrade. If set to false upgrade will not be aborted on healthchecks failure.

type

string

enum

required

The operation type. 'Upgrade' indicates to upgrade the software on the cluster. 'UploadPackageAndUpgrade' indicates to first upload the package using the url where package is hosted and then upgrade the cluster.

Allowed:

url

string

The URL where the package is hosted. This is required when the operation type is 'UploadPackageAndUpgrade'

versionName

string

Version name of the package. Example: 6.3.1h_release-20210714_0fad884e. This is required when the operation type is 'Upgrade'

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Success

defaultError