Get System Release

Returns release for the lowest deployed VCF version for a domain on the environment.If Management domain is ahead of WLD domain, VCF BOM version for the WLDdomain will be returned.

Request

URI

GET

https://{api_host}/v1/releases/system

COPY

Responses

200

Returns Release of type(s) application/json

{
    "product": "string",
    "version": "string",
    "minCompatibleVcfVersion": "string",
    "description": "string",
    "releaseDate": "string",
    "bom": [
        {
            "name": "string",
            "version": "string",
            "publicName": "string",
            "releaseURL": "string",
            "additionalMetadata": "string"
        }
    ],
    "isApplicable": false,
    "notApplicableReason": "string",
    "sku": [
        {
            "name": "string",
            "description": "string",
            "skuSpecificPatchBundles": [
                {
                    "bundleType": "string",
                    "bundleVersion": "string",
                    "version": "string"
                }
            ],
            "bom": [
                {
                    "name": "string",
                    "version": "string",
                    "publicName": "string",
                    "releaseURL": "string",
                    "additionalMetadata": "string"
                }
            ]
        }
    ],
    "updates": [
        {
            "id": "string",
            "productName": "string",
            "baseProductVersion": "string",
            "description": "string",
            "releaseUpdateURL": "string",
            "releaseDate": "string"
        }
    ],
    "patchBundles": [
        {
            "bundleId": "string",
            "bundleType": "string",
            "bundleElements": [
                "string"
            ],
            "cumulativeFromVcfVersion": "string"
        }
    ],
    "eol": "string",
    "upgradeOrder": "string"
}

string

product

Required

Name of the product e.g. "VCF"

string

version

Required

Version of the release

string

minCompatibleVcfVersion

Required

Minimum compatible VCF version, used to represent compatibility of SDDC Manager and VMware BOM components

string

description

Required

Release description with all major features.

string

releaseDate

Required

Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format

array of ProductVersion

bom

Required

Release bill of materials

boolean

isApplicable

Optional

[Deprecated] Whether bundle is applicable or not.

string

notApplicableReason

Optional

[Deprecated] Incompatibility reason for not applicable.

array of SkuBomDetails

sku

Optional

Release sku specific patch and bill of materials

array of ReleaseUpdate

updates

Optional

Collection of release updates

array of PatchBundle

patchBundles

Optional

List of patch bundles in this release

string

eol

Optional

Release eol information e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format

string

upgradeOrder

Optional

Custom upgrade order. Comma separated list of components in upgrade order. Supported components types: NSX_T_MANAGER, VCENTER, ESX_HOST.

404

Release 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.