Get Bundle

Get a Bundle

Request

URI

GET

https://sfo-vcf01.rainpole.io//v1/bundles/{id}

COPY

Path Parameters

string

Required

Bundle ID

Responses

200

Returns Bundle of type(s) application/json

{
    "applicabilityOrder": "1",
    "applicabilityStatus": "One among: SUCCESS, IN_PROGRESS, FAILED, AVAILABLE, PENDING",
    "components": [
        {
            "description": "string",
            "fromVersion": "string",
            "id": "string",
            "imageType": "One among: PATCH, INSTALL",
            "releasedDate": "string",
            "toVersion": "string",
            "type": "string",
            "vendor": "string"
        }
    ],
    "description": "string",
    "downloadStatus": "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED, RECALLED",
    "id": "string",
    "isCompliant": false,
    "isCumulative": false,
    "isPartiallyUpgraded": "true",
    "releasedDate": "string",
    "severity": "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
    "sizeMB": "number",
    "type": "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
    "vendor": "string",
    "version": "string"
}

integer As int32 As int32

applicabilityOrder

Optional

Bundle Applicability Order

string

applicabilityStatus

Optional

Bundle Applicability Status

array of BundleComponent

components

Optional

Bundle Components

string

description

Optional

Bundle Description

string

downloadStatus

Required

Bundle Download Status

string

Optional

Bundle ID

boolean

isCompliant

Optional

Is compliant with the current VCF version

boolean

isCumulative

Optional

Is Bundle Cumulative

boolean

isPartiallyUpgraded

Optional

Is Bundle partially upgraded

string

releasedDate

Optional

Bundle Release Date

string

severity

Optional

Bundle Severity

number As double As double

sizeMB

Optional

Bundle Size in MB

string

type

Required

Bundle Type

string

vendor

Optional

Bundle Vendor

string

version

Optional

Bundle Version

404

Bundle Not Found

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "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"
        }
    ],
    "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).