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 API
None
1.2. Steps API
- 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-20T00: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" : "8c13dbee-7bbb-465c-bef4-bdf10b27c7de",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "e9ed5f69-d429-4571-9082-213c1dde8fb0",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "fa008eae-c1ee-44b3-8f57-eb785ba6cb7d",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "25f1e442-8acd-47c8-a975-5a818710ff05",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "2.3.0"
}, {
"bundleId" : "0c262c5d-3b94-4075-b5c6-5a68f8fb01ee",
"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-13T00: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-06T00: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" : "59a9df85-c71e-4a4a-9f3b-7e33872a4ae6",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "c5b11e78-53fe-4fed-b7a5-ed616c5be64e",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "f311456d-5113-4724-8c41-e175472c52d7",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "41dc3f5b-e556-4eb6-ab1c-12ad0b545c28",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "f3ff322e-2055-41df-b88c-8e9edfb83975",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "NSX_MANAGER" ],
"cumulativeFromVcfVersion" : "3.7.0"
} ]
} ]
}
1.3. Related APIs API
[_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 API
The following data is required:
- Version of the Release
2.2. Steps API
- 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-06T00: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" : "13e006d9-36b6-43ec-9384-cdb14765ba64",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "c4a4d75a-dea1-4a3f-915f-78e8fd4e82bb",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "20a96150-84fd-444b-961c-e27c0295349e",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "15414046-e1e3-490d-8e61-375b4cdb5635",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "df985102-080e-496e-b4df-cc2cad5e1f04",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "NSX_MANAGER" ],
"cumulativeFromVcfVersion" : "3.7.0"
} ]
} ]
}
2.3. Related APIs API
[_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 API
The following data is required:
- Version of a Release
3.2. Steps API
- 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-13T00: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-06T00: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" : "45288fda-8d18-457d-92e1-25921f4af196",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "7b27772d-3e7d-4289-ae9e-1d9b6b3a18df",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "e73e76fa-57be-4a3b-bfa2-2143bcfc31c2",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "7cb797b8-ec49-44c6-8e27-821ed60d2c2a",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "aefccf2a-117c-4be4-a800-8cc4e750b538",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "NSX_MANAGER" ],
"cumulativeFromVcfVersion" : "3.7.0"
} ]
} ]
}
3.3. Related APIs API
[_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 API
The following data is required:
- Version of a Release
4.2. Steps API
- 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-06T00: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" : "15480ae2-5b67-4ad6-b44d-c51ce38d883d",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "c2f0c253-5d01-452e-893d-de710913dcd7",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "068e06b7-cc80-49a5-b4b9-706dcf03fc8a",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "7033f684-1d83-4d1e-802e-8cb1bc4219fc",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "000b4ea9-61ba-436e-bf96-24c564bb3818",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "NSX_MANAGER" ],
"cumulativeFromVcfVersion" : "3.7.0"
} ]
} ]
}
4.3. Related APIs API
[_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 API
The following data is required:
- ID of a domain
5.2. Steps API
- 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-06T00: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" : "d66547d7-bb11-4343-91fb-30399155a5fb",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "66b2d90e-1d1b-452a-bea3-84fc89be8649",
"bundleType" : "EVORACK",
"bundleElements" : [ "SDDC_MANAGER_VCF" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "96f8b839-5cd1-4509-ac8e-543848b1fd39",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "VCENTER" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "b52c4ad0-6844-4875-8ce9-73c47bd9edc4",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "ESX_HOST" ],
"cumulativeFromVcfVersion" : "3.7.0"
}, {
"bundleId" : "508b7a56-8efd-49f9-aeb4-feeae8fb722f",
"bundleType" : "VMWARE_SOFTWARE",
"bundleElements" : [ "NSX_MANAGER" ],
"cumulativeFromVcfVersion" : "3.7.0"
} ]
} ]
}
5.3. Related APIs API
[_getreleases] API [_getmanifest] API [_savemanifest] API
Last updated 2024-06-21 01:22:12 -0700