API Guide

The required vCenter user privilege for all other APIs are verified when you trigger the API.
Command or URL: /Services/ConsoleService/OperationalContext
Method: POST
Request Body:
{
"consoleId": "{vCenterID}",
"consoleUserCredential":
{
"username": "{vCenter username}",
"domain": "{domain}",
"password": "{vCenter password}"
}
}
For more information about request body parameters, see Request body on page 92.
Parameters: None
vCenter privileges required: None
HTTP response code:
Table 13. HTTP response code
Code Description or response object
204 OK
400 Invalid parameters
401 Authorization failure
403 Failed to login to vCenter
429 Too many requests
500 Internal Server error / timeout
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 112.
Example Response: No content
Get cluster details
Description: Gets the cluster details of the given cluster ID. You can view all the hosts belong to the cluster. The vSAN and
vSphere cluster details are displayed.
Command or URL: /Services/ConsoleService/Clusters/{cluster-id}
Method: GET
Authorization: Bearer authentication
Parameters:
Table 14. Parameters
Parameter Value Description Default value Parameter
type
Data type
id (required) Resource ID. Use the cluster ID received from
the Get vCenter tree view of datacenter
API. For more information, see Get vCenter
tree view of data center on page 44.
N/A Path String
vCenter privileges required: None
HTTP response code:
46
Console management