Getting StartedAPI ReferenceRecipesGitHub
API Reference

Update cluster software

put
https://helios.cohesity.com/v2/clusters/softwares

Update the software on the cluster through upgrade and/or patch.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The parameters to update the software on the cluster.

abortDownloadParams
object

Specifies parameters for the AbortDownload operation. Used to selectively abort only patch or upgrade package downloads.

assessSoftwareUpdateParams
object

Specifies parameters to assess cluster state for the software update (upgrade/patch).

string
enum

Type of node where upgrade has to be performed using the provided package.

  • ClusterNode
  • ConnectorNode nodeType is only applicable for following operation types.
  • DownloadUpgradePackage
  • DownloadPatchPackage
  • DownloadUpgradeAndPatchPackages
Allowed:
string
enum
required

The operation type.

  • DownloadUpgradePackage - Operation to download upgrade package.
  • DownloadPatchPackage - Operation to download patch package.
  • DownloadUpgradeAndPatchPackages - Operation to download upgrade and patch packages.
  • DownloadAndUpgrade - Operation to download package and and then upgrade the cluster.
  • DownloadAndApplyPatch - Operation to download package and and then apply the patch.
  • DownloadAndUpgradeWithPatch - Operation to download upgrade and patch packages, and then, upgrade the cluster and immediately patch it
  • Upgrade - Operation to upgrade the software on the cluster.
  • ApplyPatch - Operation to apply the patch.
  • RevertPatch - Operation to revert the patch.
  • UpgradeAndPatch - Operation to upgrade the software on the cluster and apply a patch.
  • AssessSoftwareUpdate - Operation to perform checks to assess the state of cluster pre/post software update (upgrade/patch).
  • AbortApplyPatch - Operation to abort the patch.
  • AbortUpgrade - Operation to abort the upgrade.
  • AbortDownload - Operation to abort an ongoing patch or upgrade package download. Optionally accepts abortDownloadParams to specify which package type to abort.
patchParams
object

One of packageUrl or versionName must be specified.

upgradeParams
object

Parameters to upgrade the cluster software One of packageUrl or versionName must be specified.

Headers
int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Updated 16 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 16 days ago