Get Bundle

Get Bundle

Get a Bundle

Request
URI
GET
https://{api_host}/v1/bundles/{id}
COPY
Path Parameters
string
id
Required

Bundle ID

Responses
200

Ok

Returns Bundle of type(s) application/json 
{
    "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
}
string
id
Optional

Bundle ID

string
type
Required

Bundle Type

string
description
Optional

Bundle Description

string
version
Optional

Bundle Version

string
severity
Optional

Bundle Severity

string
vendor
Optional

Bundle Vendor

string
releasedDate
Optional

Bundle Release Date

boolean
isCumulative
Optional

Is Bundle Cumulative

boolean
isCompliant
Optional

Is compliant with the current VCF version

number As double As double
sizeMB
Optional

Bundle Size in MB

string
downloadStatus
Required

Bundle Download Status

array of BundleComponent
components
Optional

Bundle Components

string
applicabilityStatus
Optional

Bundle Applicability Status

integer As int32 As int32
applicabilityOrder
Optional

Bundle Applicability Order

boolean
isPartiallyUpgraded
Optional

Is Bundle partially upgraded


404

Bundle Not Found

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.


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
Bundles Operations
DELETE
Delete Bundle
GET
Get Bundle
GET
Get Bundles
GET
Get Bundles For Skip Upgrade
PATCH
Start Bundle Download By ID
PATCH
Update Bundle Compatibility Sets
Deprecated
POST
Upload Bundle