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 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" : "db8e6661-a556-49cd-81b3-a63dae7351e8",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "cb82ce02-396d-49af-870c-8294e14587d3",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "13abbd26-ff37-47ba-be23-5761c26fca32",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "661b30f5-c23d-4737-90e9-47f4c89aa5c3",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "0eba4823-b6cc-4ef6-9c16-ccee0f6cb682",
"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" : "efc1f903-fb9e-44e4-8952-2a8cd5982808",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "84861f7e-d749-443b-acf1-aa9e2504f9af",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "0724f90b-b8ba-4286-94c3-aeffa6216cd4",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "8c95bef4-5a48-44c9-af41-fb758ce6bc45",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "2f2cd512-775b-4303-8672-6ed1a8be587c",
"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" : "8398b3cd-225b-4157-bf1b-6dc5ac4af632",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "8567b13a-eb41-4657-88ea-3b2b5ac1d6fb",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "b3352afe-f144-4168-9a62-20d8a6abac78",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "a46d71d5-6777-4632-b86b-2b15e00f6858",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "1404ae95-ce22-4c0c-961d-df68ca109760",
"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" : "67892128-54ae-40db-9ae9-5e538c929221",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "2e274193-bd93-4c72-8403-03a2fcaae888",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "96be3706-4294-4767-a5da-483864cb87ee",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "baee1309-e2b1-419d-8a17-bf5383760e4e",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "d6aed89f-3dbf-417f-8d2f-a8f20ba2801d",
"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" : "a717ff01-6bab-4143-b7ea-cda3e0a1a9e8",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "b261aa24-7821-45a2-89c2-19c06256479d",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "91b7a6f5-2210-4fb5-8483-4cfdd678bd3a",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "66d93796-d72e-4647-9905-0b8da2fc88ae",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "c5ddb441-496a-4177-8144-b0aeefebad83",
"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" : "7798d785-cc6a-4aa0-b722-98917486fe94",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "ea6daec7-ec84-4f8c-ae26-bbb318cdca98",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "e9b96d8c-b4d2-49cb-9e0e-482429a5a143",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "a303272f-e8ef-4211-bb88-03f3789a04f3",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "48cf3c59-a1e4-45ea-925f-f52c3b0be263",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "NSX_MANAGER" ],
"cumulativeFromVcfVersion" : "3.7.0"
} ]
} ]
}
Last updated 2024-03-14 07:59:42 -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