Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.


  • UpgradeStepItem


Issues?: string[]

A list of strings containing detailed information about the errors encountered in a particular step.

ProgressPercent?: number

The Floating point value representing progress percentage of a particular step.

UpgradeStep?: string

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

UpgradeStepStatus?: string

The status of a particular step during an upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed