Version Aliases For Bundle Component Type APIs
APIs for managing Version Alias Configuration
Table of Contents
1. Get Version Aliases
- Get Version Alias Configuration API is used to get version alias configuration.
1.1. Prerequisites API
None
1.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/version-aliases' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/system/settings/version-aliases 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: 177
{
"elements" : [ {
"bundleComponentType" : "VCENTER",
"versionAliases" : [ {
"version" : "6.7.0-14765156",
"aliases" : [ "6.7.0-14765268" ]
} ]
} ]
}
1.3. Related APIs API
[_updateversionaliasconfigurations] API [_updateversionaliasconfiguration] API [_deletealiasversionsbysoftwaretypeandbaseversion] API [_deleteversionaliasbysoftwaretype] API
2. Update Version Aliases
Update Version Alias Configurations
- Update Version Alias Configurations API is used to update multiple version alias configurations.
2.1. Prerequisites API
The following data is required
Bundle component type
One or more version aliases
Tip : Refer to: VersionAliasesForBundleComponentTypeSpec.
2.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/version-aliases' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '{
"versionAliasesForBundleComponentTypes" : [ {
"bundleComponentType" : "VCENTER",
"versionAliases" : [ {
"version" : "6.7.0-14765156",
"aliases" : [ "6.7.0-14765268" ]
} ]
} ],
"forceUpdate" : true
}'
HTTP Request
PUT /v1/system/settings/version-aliases HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 230
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
{
"versionAliasesForBundleComponentTypes" : [ {
"bundleComponentType" : "VCENTER",
"versionAliases" : [ {
"version" : "6.7.0-14765156",
"aliases" : [ "6.7.0-14765268" ]
} ]
} ],
"forceUpdate" : true
}
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 177
{
"elements" : [ {
"bundleComponentType" : "VCENTER",
"versionAliases" : [ {
"version" : "6.7.0-14765156",
"aliases" : [ "6.7.0-14765268" ]
} ]
} ]
}
Update Version Alias Configuration * Update Version Alias Configuration API is used to update a specific version alias configuration.
2.3. Prerequisites API
The following data is required
Bundle component type
Version
Alias specification
Tip : Refer to: AliasSpec.
2.4. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/version-aliases/VCENTER/6.7.0-14765156' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '{
"aliases" : [ "6.7.0-14765268" ],
"forceUpdate" : true
}'
HTTP Request
PUT /v1/system/settings/version-aliases/VCENTER/6.7.0-14765156 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 62
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
{
"aliases" : [ "6.7.0-14765268" ],
"forceUpdate" : true
}
HTTP Response
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 177
{
"elements" : [ {
"bundleComponentType" : "VCENTER",
"versionAliases" : [ {
"version" : "6.7.0-14765156",
"aliases" : [ "6.7.0-14765268" ]
} ]
} ]
}
2.5. Related APIs API
[_getversionaliasconfiguration] API [_deletealiasversionsbysoftwaretypeandbaseversion] API [_deleteversionaliasbysoftwaretype] API
3. Delete Version Aliases
Delete Version Aliases
- Delete Version Alias Configuration API is used to delete version alias configurations by bundle component type, version and alias version.
3.1. Prerequisites API
The following data is required
Bundle component type
Bundle component version
One or more alias versions to be removed
3.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/version-aliases/VCENTER/6.7.0-14765156' -i -X DELETE \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '[ "6.7.0-14765268" ]'
HTTP Request
DELETE /v1/system/settings/version-aliases/VCENTER/6.7.0-14765156 HTTP/1.1
Content-Type: application/json
Content-Length: 20
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
[ "6.7.0-14765268" ]
HTTP Response
HTTP/1.1 204 No Content
Delete Version Alias by Type and Version
- Delete Version Alias Configuration API is used to delete a version alias configuration by bundle component type and version.
3.3. Prerequisites API
The following data is required
Bundle component type
Bundle component version
3.4. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/version-aliases/VCENTER/6.7.0-14765156' -i -X DELETE \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
DELETE /v1/system/settings/version-aliases/VCENTER/6.7.0-14765156 HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 204 No Content
Delete Version Alias by Type
- Delete Version Alias for a bundle component type API is used to delete a version alias configuration by bundle component type.
3.5. Prerequisites API
The following data is required
- Bundle component type
3.6. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/version-aliases/VCENTER' -i -X DELETE \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
DELETE /v1/system/settings/version-aliases/VCENTER HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 204 No Content
3.7. Related APIs API
[_getversionaliasconfiguration] API [_updateversionaliasconfigurations] API [_updateversionaliasconfiguration] API
Last updated 2024-08-27 16:13:54 -0700