API Guide

NOTE: All the URIs and query parameters are case-sensitive.
Request headers
The request header represents headers in the client HTTPS request that are used to communicate client preferences to the
service end-point. The bearer token is the request header.
Sequence of API for firmware update
To perform the firmware update, run the following APIs in the given order:
1. AuthenticationService/login—Start an OMIVV session using OMIVV credentials. You will receive an access token.
All subsequent APIs must include this token as a bearer token as part of request header.
2. ConsoleService/Consoles—Get all registered vCenters information
3. ConsoleService/Consoles/{id}—Get the vCenter tree view of all the datacenters, clusters, and hosts of the given
vCenter ID.
4. ConsoleService/OperationalContext—Set the vCenter which is the context of the API operation
5. ConsoleService/Clusters/{id}—Get cluster details
6. ConsoleService/Clusters/{id}/Details—Verify cluster health status on OMIVV context.
7. PluginProfileService/ClusterProfiles—Get the list of all cluster profiles.
8. PluginProfileService/ClusterProfiles/{id}—Get the details of a given cluster profile ID.
9. PluginProfileService/RepositoryProfiles—Get the list of repository profile details.
10. PluginProfileService/RepositoryProfiles/{id}—Retrieve content of specified repository.
11. RepositoryManagementService/RepositoryData?
repoProfileID={repoProfileID}&bundleId={bundleId}&systemId={systemId}—Get the firmware
repository inventory report.
12. UpdateService/FWReport—Create firmware inventory report of the individual or clustered host based on the specified
repository
13. Services/UpdateService/Jobs—Create firmware update job.
14. UpdateService/Jobs—Get all firmware update jobs
15. UpdateService/Jobs/{id}—Get the firmware update job details
16. AuthenticationService/logoff—End an OMIVV session
6
Overview