Get Upgrades

Get Upgrades

Retrieve a list of upgrades

Request
URI
GET
https://{api_host}/v1/upgrades
COPY
Query Parameters
string
status
Optional

Status of the upgrades you want to retrieve

string
bundleId
Optional

Bundle Id for the upgrade

string
bundleType
Optional

Bundle type of the upgrades you want to retrieve


Responses
200

Ok

Returns PageOfUpgrade of type(s) application/json
{
    "elements": [
        {
            "id": "string",
            "bundleId": "string",
            "resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
            "parallelUpgrade": false,
            "resourceUpgradeSpecs": [
                {
                    "resourceId": "string",
                    "shutdownVms": false,
                    "toVersion": "string",
                    "scheduledTimestamp": "string",
                    "upgradeNow": false,
                    "personalitySpec": {
                        "personalityId": "string",
                        "hardwareSupportSpecs": [
                            {
                                "name": "string",
                                "packageSpec": {
                                    "name": "string",
                                    "version": "string"
                                }
                            }
                        ]
                    },
                    "customIsoSpec": {
                        "id": "string"
                    },
                    "enableQuickboot": false,
                    "evacuateOfflineVms": false,
                    "esxUpgradeOptionsSpec": {
                        "esxUpgradeFailureAction": {
                            "retryDelay": 0,
                            "retryCount": 0,
                            "action": "FAIL, RETRY"
                        },
                        "enforceHclValidation": false,
                        "enableQuickPatch": false,
                        "enableQuickboot": false,
                        "evacuateOfflineVms": false,
                        "disableHac": false,
                        "disableDpm": false,
                        "preRemediationPowerAction": "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY"
                    }
                }
            ],
            "status": "string",
            "taskId": "string",
            "nsxtUpgradeUserInputSpec": {
                "nsxtHostClusterUpgradeSpecs": [
                    {
                        "hostClusterId": "string",
                        "hostParallelUpgrade": false,
                        "liveUpgrade": false
                    }
                ],
                "nsxtEdgeClusterUpgradeSpecs": [
                    {
                        "edgeClusterId": "string",
                        "edgeParallelUpgrade": false
                    }
                ],
                "nsxtUpgradeOptions": {
                    "isEdgeOnlyUpgrade": false,
                    "isHostClustersUpgradeParallel": false,
                    "isEdgeClustersUpgradeParallel": false
                },
                "nsxtId": "string"
            },
            "bundle": {
                "id": "string",
                "type": "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
                "description": "string",
                "version": "string",
                "severity": "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
                "vendor": "string",
                "releasedDate": "string",
                "isCumulative": false,
                "isCompliant": false,
                "sizeMB": "number",
                "downloadStatus": "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED, RECALLED",
                "components": [
                    {
                        "description": "string",
                        "vendor": "string",
                        "releasedDate": "string",
                        "toVersion": "string",
                        "fromVersion": "string",
                        "imageType": "One among: PATCH, INSTALL",
                        "id": "string",
                        "type": "string"
                    }
                ],
                "applicabilityStatus": "One among: SUCCESS, IN_PROGRESS, FAILED, AVAILABLE, PENDING",
                "applicabilityOrder": 1,
                "isPartiallyUpgraded": true
            },
            "endTime": 0,
            "vcenterUpgradeUserInputSpec": {
                "resourceId": "string",
                "upgradeMechanism": "One among: ReducedDowntimeMigration, InPlace",
                "startSwitchoverTimestamp": "string",
                "temporaryNetwork": {
                    "networkMode": "One among: STATIC, AUTOMATIC",
                    "ipAddress": "string",
                    "subnetMask": "string",
                    "gateway": "string"
                }
            }
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of object
elements
Optional

The list of elements included in this page

object
pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


404

Upgrade Not Found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/upgrades