Get Bundles | VMware Cloud Foundation API

Get Bundles

Get all Bundles i.e uploaded bundles and also bundles available via depot access.

Request

URI

GET

https://{api_host}/v1/bundles

COPY

Query Parameters

string

productType

Optional

The type of the product

productType example

VRA,VROPS,VRLI

boolean

isCompliant

Optional

Is compliant with the current VCF version

string

bundleType

Optional

The type of the bundle

Responses

200

Returns PageOfBundle of type(s) application/json

{
    "elements": [
        {
            "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
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

array of Bundle

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.