GET Vsphere UUID Hosts Esxi Host

GET Vsphere UUID Hosts Esxi Host

Get ESXi host with the specified UUID in the specified vSphere Server along with it's configuration details.

Request
URI
GET
https://{api_host}/api/v2/vsphere/{UUID}/hosts/{esxiHost}
COPY
Path Parameters
string
esxiHost
Required

Hostname of ESXi host

string
UUID
Required

vCenter Server UUID


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved ESXi host with the specified UUID and it's configuration details.

{
    "host": {
        "hostname": "example-esxi-hostname",
        "os": "VMware ESXi",
        "version": "5.0.1",
        "build": "12345",
        "configured": true,
        "syslogProtocol": "tcp",
        "unsupported": false,
        "disconnected": true
    }
}
object
host
Optional

host


401
Operation doesn't return any data structure

404

Specified ESXi host is not available under specified vSphere instance.

Configuration with specified vCenter Server UUID does not exist.

Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/vsphere/{UUID}/hosts/{esxiHost}