Get Upgradables

Get Upgradables

Fetches the list of Upgradables in the System. Only one Upgradable becomes AVAILABLE for Upgrade. The Upgradables provides information that can be use for Precheck API and also in the actual Upgrade API call.

Request
URI
GET
https://{api_host}/v1/system/upgradables
COPY
Responses
200

Ok

Returns PageOfUpgradable of type(s) application/json 
{
    "elements": [
        {
            "bundleId": "string",
            "bundleType": "string",
            "resource": {
                "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                "fqdn": "sfo-vc01.rainpole.io",
                "type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
                "name": "string",
                "sans": [
                    "sfo-vc01.rainpole.io"
                ]
            },
            "softwareComponents": [
                {
                    "id": "string",
                    "type": "string"
                }
            ],
            "status": "string",
            "errors": [
                {
                    "errorCode": "string",
                    "errorType": "string",
                    "arguments": [
                        "string"
                    ],
                    "context": {
                        "context": "string"
                    },
                    "message": "string",
                    "remediationMessage": "string",
                    "causes": [
                        {
                            "type": "string",
                            "message": "string"
                        }
                    ],
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string"
                }
            ]
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of Upgradable
elements
Optional

The list of elements included in this page

PageMetadata
pageMetadata
Optional

Represents pageable elements pagination metadata


500

InternalServerError

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


On This Page
Upgradables Operations
GET
Get Nsx Upgrade Resources
GET
Get Upgradables
GET
Get Upgradables By Domain
GET
Get Upgradables Clusters