Releases APIs

Releases APIs

APIs for managing Releases

Table of Contents

1. Get all releases

  • Get Releases API is used to get the information for all the SDDC Manager releases along with the versions of each product within the given release.

1.1. Prerequisites

None

1.2. Steps

  • Invoke the API.

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/releases' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

GET /v1/releases HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 4742

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "3.0.0",
    "description" : "VMware Cloud Foundation 3.0.0 Release",
    "releaseDate" : "2018-09-19T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "3.0.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "6.5.0-9451637",
      "changeId" : "9451637",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "6.5.0-9298722",
      "changeId" : "9298722",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_MANAGER",
      "version" : "6.4.1-8599035",
      "changeId" : "8599035",
      "publicName" : "NSX-V Data Center"
    }, {
      "name" : "VROPS",
      "version" : "6.7.0-8183617",
      "changeId" : "8183617",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "cd40c851-fa88-4d8b-aa0d-cc909771239d",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "2079e839-b0c8-4c3f-864c-4074e0f69dbc",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "ebc7d164-ff5e-42f8-b221-4f4f80f33ca8",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "501dd1a4-38ab-4385-a173-c55ebf05ca3f",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "e394e724-e4aa-49c3-9c3c-0295bfc77f61",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    } ]
  }, {
    "product" : "vcf",
    "version" : "3.5.0",
    "description" : "VMware Cloud Foundation 3.5.0 Release",
    "releaseDate" : "2018-12-12T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "3.5.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "6.7.0-10244745",
      "changeId" : "10244745",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "6.7.0-10764712",
      "changeId" : "10764712",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_MANAGER",
      "version" : "6.4.4-11197766",
      "changeId" : "11197766",
      "publicName" : "NSX-V Data Center"
    }, {
      "name" : "VROPS",
      "version" : "7.0.0-10098133",
      "changeId" : "10098133",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ ]
  }, {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-05T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "changeId" : "16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "changeId" : "16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "changeId" : "16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "changeId" : "16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "8c99348b-be3c-4603-a5df-fca5bd0844d4",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "a5e4058f-ed4a-4036-9432-10ff2fabf271",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "ba6372c5-7600-42bc-9345-34174dafee0a",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "280aedd3-68ef-48e6-a6e9-9993c1584db4",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "8813c6d5-3c9d-44e9-8744-0367af2cc05c",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

1.3. Related APIs

[_getmanifest] API [_savemanifest] API

2. Get release for a given version

  • This API is used to get the release for a specified version.

2.1. Prerequisites

The following data is required:

  • Version of the Release

2.2. Steps

  • Invoke the API.

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/releases?versionEq=9.0.0.0' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

GET /v1/releases?versionEq=9.0.0.0 HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2848

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "9.0.0.0",
    "description" : "VCF version 9.0.0.0",
    "releaseDate" : "2024-12-31T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "9.0.0.0.123456",
      "changeId" : "123456",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "9.0.0.0.123456",
      "changeId" : "123456",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "9.0.0.0.123456",
      "changeId" : "123456",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "9.0.0.0.123456",
      "changeId" : "123456",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "9.0.0.0.123456",
      "changeId" : "123456",
      "publicName" : "VMware Cloud Foundation Operations"
    }, {
      "name" : "VRSLCM",
      "version" : "9.0.0.0.123456",
      "changeId" : "123456",
      "publicName" : "VMware Cloud Foundation Operations fleet management"
    } ],
    "sku" : [ {
      "name" : "VCF",
      "description" : "VCF SKU",
      "skuSpecificPatchBundles" : [ ],
      "bom" : [ {
        "name" : "SDDC_MANAGER",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "SDDC Manager"
      }, {
        "name" : "VCENTER",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "vCenter Server Appliance"
      }, {
        "name" : "HOST",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "VMware ESXi"
      }, {
        "name" : "NSX_T_MANAGER",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "NSX-T Data Center"
      }, {
        "name" : "VROPS",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "VMware Cloud Foundation Operations"
      }, {
        "name" : "VRSLCM",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "VMware Cloud Foundation Operations fleet management"
      } ]
    }, {
      "name" : "VVF",
      "description" : "VVF SKU",
      "skuSpecificPatchBundles" : [ ],
      "bom" : [ {
        "name" : "VCENTER",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "vCenter Server Appliance"
      }, {
        "name" : "HOST",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "VMware ESXi"
      }, {
        "name" : "VROPS",
        "version" : "9.0.0.0.123456",
        "changeId" : "123456",
        "publicName" : "VMware Cloud Foundation Operations"
      } ]
    } ],
    "updates" : [ ],
    "patchBundles" : [ ],
    "minInstallerVersion" : "9.0.0.0"
  } ]
}

2.3. Related APIs

[_getreleases] API [_getmanifest] API [_savemanifest] API

3. Get future releases for a given version

  • This API is used to get all future releases for a given version.

3.1. Prerequisites

The following data is required:

  • Version of a Release

3.2. Steps

  • Invoke the API.

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/releases?versionGt=2.3.0' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

GET /v1/releases?versionGt=2.3.0 HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2854

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "3.5.0",
    "description" : "VMware Cloud Foundation 3.5.0 Release",
    "releaseDate" : "2018-12-12T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "3.5.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "6.7.0-10244745",
      "changeId" : "10244745",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "6.7.0-10764712",
      "changeId" : "10764712",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_MANAGER",
      "version" : "6.4.4-11197766",
      "changeId" : "11197766",
      "publicName" : "NSX-V Data Center"
    }, {
      "name" : "VROPS",
      "version" : "7.0.0-10098133",
      "changeId" : "10098133",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ ]
  }, {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-05T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "changeId" : "16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "changeId" : "16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "changeId" : "16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "changeId" : "16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "4e594a82-3676-4231-ab57-eb1cfd99bd0d",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "c0421b71-79ad-4b2b-ab38-22f49e9f4ab4",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "613f2715-9ba4-4eec-9ef9-4567f6736277",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "b567bf89-0422-4d93-ac66-5ca8fec4feb9",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "5514a6c3-063d-41f1-be4c-90005d43abf6",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

3.3. Related APIs

[_getreleases] API [_getmanifest] API [_savemanifest] API

4. Get applicable target releases for a given version

  • This API is used to get all applicable target releases for a given version.

4.1. Prerequisites

The following data is required:

  • Version of a Release

4.2. Steps

  • Invoke the API.

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/releases?applicableForVersion=2.3.0' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

GET /v1/releases?applicableForVersion=2.3.0 HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1919

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-05T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "changeId" : "16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "changeId" : "16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "changeId" : "16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "changeId" : "16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "c6fb7c77-0b67-4f96-8c1b-ac8aafbd1028",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "f61c6ce0-3954-46d8-ae8a-e3d5da4bf922",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "2edfe178-170c-4992-b1bc-a1a8f604c30e",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "502ae18e-dc24-43ce-b88f-b5e9292eab0d",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "93e583f1-ee9d-438b-b4a8-4dd85ff73e43",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

4.3. Related APIs

[_getreleases] API [_getmanifest] API [_savemanifest] API

5. Get Current Release for Domain

  • This API is used to get the release for a specified domain ID.

5.1. Prerequisites

The following data is required:

  • ID of a domain

5.2. Steps

  • Invoke the API.

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/releases?domainId=mgmt-domain-1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

GET /v1/releases?domainId=mgmt-domain-1 HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1919

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-05T18:30:00.000Z",
    "bom" : [ {
      "name" : "SDDC_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "changeId" : "16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "changeId" : "16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "changeId" : "16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "changeId" : "16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "75e791b9-909c-4b4b-9fd7-61b5c1f4130c",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "ba3dc1b7-003e-4559-a0ca-003a1e1e8f4e",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "80d775cb-0c52-4b89-91c3-f591ef32e4a1",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "69d5949c-2fb5-4956-a336-f1c2c945e474",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "f6d00d0a-8b3d-4a46-b4d6-f69b8242ff06",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

5.3. Related APIs

[_getreleases] API [_getmanifest] API [_savemanifest] API
Last updated 2025-03-21 15:13:04 +0530

Operations
GET
Get Releases
Retrieve a list of releases including current and target versions
GET
Get System Release
Retrieve the lowest deployed release of VMware Cloud Foundation
GET
Get Future Releases
Retrieve a list of future releases by domain ID