Releases APIs | VMware Cloud Foundation API

Releases APIs

APIs for managing Releases

Table of Contents

Get all releases
Get release for a given version
Get future releases for a given version
Get applicable target releases for a given version
Get Current Release for Domain

1. Get all releases

Get Releases API is used to get the information for all the VMware Cloud Foundation 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: 4380

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "3.0.0",
    "description" : "VMware Cloud Foundation 3.0.0 Release",
    "releaseDate" : "2018-09-20T07:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "3.0.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "6.5.0-9451637",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "6.5.0-9298722",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_MANAGER",
      "version" : "6.4.1-8599035",
      "publicName" : "NSX-V Data Center"
    }, {
      "name" : "VROPS",
      "version" : "6.7.0-8183617",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "044b7ec9-4690-49cb-a440-4a47c4983e97",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "251166d9-985a-4908-a522-0bcb0f8e2a16",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "9aeb5559-15d8-4de8-ae27-84f0ba42145e",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "9dc52fe5-987c-4340-88b1-6fbf4d8dd0da",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "2.3.0"
    }, {
      "bundleId" : "24b81306-2558-48ac-9a0e-68a5b0fe210c",
      "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-13T08:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "3.5.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "6.7.0-10244745",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "6.7.0-10764712",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_MANAGER",
      "version" : "6.4.4-11197766",
      "publicName" : "NSX-V Data Center"
    }, {
      "name" : "VROPS",
      "version" : "7.0.0-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-06T07:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "38735683-7dd3-4768-a612-694e0270ecb4",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "a0890e1b-0cac-4518-bf0e-03e3348e20e8",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "4a1fead3-04c8-49f4-914a-38df893c6734",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "67673e86-97f8-40dc-8aa2-62765080b6f5",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "4327e4cf-1411-4be9-97c9-a1384063ef40",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

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=4.1.0' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/releases?versionEq=4.1.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: 1797

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-06T07:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "41f57c9c-37c6-4aaa-96a0-119915603d0a",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "feffff9c-2fec-4ef2-a3ec-2fcfef4cf067",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "09012ae8-6ae5-4edb-8f5d-7fdbc5534135",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "5d1ca254-a2e9-452d-aca7-eab03df28d34",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "5f033db8-58e5-4236-b595-12c2fc3c91dc",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

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: 2610

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "3.5.0",
    "description" : "VMware Cloud Foundation 3.5.0 Release",
    "releaseDate" : "2018-12-13T08:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "3.5.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "6.7.0-10244745",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "6.7.0-10764712",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_MANAGER",
      "version" : "6.4.4-11197766",
      "publicName" : "NSX-V Data Center"
    }, {
      "name" : "VROPS",
      "version" : "7.0.0-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-06T07:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "36b7ba8f-1539-403a-ac5f-669d31ddacfc",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "73c89a23-094c-4a1a-add0-42f7935ba988",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "e9be0a44-6c0a-4e33-9781-90b7eda98a37",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "2f91b177-4fe7-460f-b521-860bee5d09ee",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "56f08544-2fab-4ad2-8243-cf9627338aab",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

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: 1797

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-06T07:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "0adfd54c-a81b-4a6c-87e2-eab883d5d665",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "53d7f1ea-b5db-4ef2-863a-338cbda72682",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "c2045205-0a29-4e8f-ae67-c3fc93b06cec",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "b85d905c-1922-47f6-899a-82bb0538c816",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "91dbce89-3407-4a85-88b6-56468bb838fa",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

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: 1797

{
  "elements" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-06T07:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "f62a29d8-ea1f-453f-9b4d-15d9b55f7886",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "5fb00753-2f3f-4d59-8906-eb972699108d",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "7617cb0b-3020-4a46-8183-490101d55e45",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "e4bf32ff-307b-4641-b1c5-b1b665edd953",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "5bf26679-81b0-41ec-bc70-26737de7f5bf",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ]
}

Last updated 2023-09-23 19:05:04 -0700

Operations

GET

Get Future Releases

Retrive a list of future release by domain ID

GET

Get Releases

Retrieve a list of release including current and target versions

GET

Get System Release

Retrieve the lowest deployed release of VMware Cloud Foundation