Get Releases
Get all Releases, with option to get current release for a domain, get release by version or get future releases for a versionor get all the applicable target release. Domain VCF release calculations consider SDDC-M, BOM stack components(life cycle managed by LCM eg: Vcenter, Esx, Nsx) to compute Management domain VCF version, BOM stack components(life cycle managed by LCM) to compute VI domain VCF version respectively. Eg: Management domain component stack versions: [SDDC-M: 5.2.1.0, VC: 8.0U3, NSX:4.2.1.3, ESX: 8.0U3]. VCF version computed will be 5.2.1.0. VI domain component stack versions: [VC: 9.0.0.0, NSX: 9.0.0.0, ESX: 9.0.0.0]. VCF version computed is 9.0.0.0 for VI domain.
Domain ID to get current release of the domain
9ab78840-ee25-11e8-a8fc-d71c338107bdRelease version to get its release
3.9.0Release version to get its future releases
4.0.0.0Release version to get its current & future releases
9.0.0.0Release version to get applicable releases
4.0.1.0Releases with minInstallerVersion less than given minInstallerVersion
9.0.0.0[Deprecated] Get all future releases for a given domain
trueFilter only compatible releases on the system
trueOK
{
"elements": [
{
"product": "string",
"version": "string",
"minCompatibleVcfVersion": "string",
"description": "string",
"releaseDate": "string",
"bom": [
{
"name": "string",
"version": "string",
"changeId": "string",
"publicName": "string",
"releaseURL": "string",
"additionalMetadata": "string",
"automatedInstall": false,
"lifecycleManagedBy": "string"
}
],
"isApplicable": false,
"notApplicableReason": "string",
"sku": [
{
"name": "string",
"description": "string",
"skuSpecificPatchBundles": [
{
"bundleType": "string",
"bundleVersion": "string",
"version": "string"
}
],
"bom": [
{
"name": "string",
"version": "string",
"changeId": "string",
"publicName": "string",
"releaseURL": "string",
"additionalMetadata": "string",
"automatedInstall": false,
"lifecycleManagedBy": "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",
"minInstallerVersion": "string"
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}The list of elements included in this page
Represents pageable elements pagination metadata
Forbidden
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Release Not Found
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Internal Server Error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/releases