Get Upgrades

Get Upgrades

Retrieve a list of upgrades

Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/upgrades
COPY
Query Parameters
string
status
Optional

Status of the upgrades you want to retrieve

string
bundleId
Optional

Bundle Id for the upgrade

Responses
200

OK

Returns PageOfUpgrade of type(s) application/json 
{
    "elements": [
        {
            "bundleId": "string",
            "id": "string",
            "nsxtUpgradeUserInputSpec": {
                "nsxtEdgeClusterUpgradeSpecs": [
                    {
                        "edgeClusterId": "string",
                        "edgeParallelUpgrade": false
                    }
                ],
                "nsxtHostClusterUpgradeSpecs": [
                    {
                        "hostClusterId": "string",
                        "hostParallelUpgrade": false,
                        "liveUpgrade": false
                    }
                ],
                "nsxtId": "string",
                "nsxtUpgradeOptions": {
                    "isEdgeClustersUpgradeParallel": false,
                    "isEdgeOnlyUpgrade": false,
                    "isHostClustersUpgradeParallel": false
                }
            },
            "parallelUpgrade": false,
            "resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
            "resourceUpgradeSpecs": [
                {
                    "customISOSpec": {
                        "hostIds": [
                            "string"
                        ],
                        "id": "string"
                    },
                    "enableQuickboot": false,
                    "evacuateOfflineVms": false,
                    "personalitySpec": {
                        "hardwareSupportSpecs": [
                            {
                                "name": "string",
                                "packageSpec": {
                                    "name": "string",
                                    "version": "string"
                                }
                            }
                        ],
                        "personalityId": "string"
                    },
                    "resourceId": "string",
                    "scheduledTimestamp": "string",
                    "shutdownVms": false,
                    "toVersion": "string",
                    "upgradeNow": false
                }
            ],
            "status": "string",
            "taskId": "string"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of Upgrade
elements
Optional

The list of elements included in this page

PageMetadata
pageMetadata
Optional

Represents pageable elements pagination metadata


404

Upgrade not found

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


500

Internal Server Error

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


On This Page
Upgrades Operations
GET
Get Upgrade By Id
GET
Get Upgrade Precheck By ID
GET
Get Upgrades
POST
Perform Upgrade
POST
Start Upgrade Precheck
PATCH
Update Upgrade Schedule