Hypervisors Api Get Facets

Hypervisors Api Get Facets
List the hypervisor filter values

Distinct vCenter and cluster values across the whole persisted inventory, for filter drop-downs. Accessible to every authenticated role.

Request
URI
GET
https://{api_host}/api/v1/hypervisors/facets
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The facet values for the hypervisor filters

Returns HypervisorFacetsDto of type(s) application/json
{
    "vcenterIds": [
        "db-1"
    ],
    "parentLocators": [
        "domain-c8"
    ],
    "vcenters": [
        {
            "id": "db-1",
            "displayName": "Primary vCenter"
        }
    ],
    "clusters": [
        {
            "id": "domain-c8",
            "displayName": "Production Cluster"
        }
    ]
}
array of string
vcenterIds
Required  

Distinct vCenter identifiers stored on the hypervisor inventory, used as the vCenter filter values; limited to hypervisors of configured vCenter connections and empty when no vCenter connection is configured

array of string
parentLocators
Required  

Distinct parent locators (cluster identifiers) stored on the hypervisor inventory, used as the cluster filter values; limited to hypervisors of configured vCenter connections and empty when no vCenter connection is configured

array of object
vcenters
Required  

One entry per identifier in vcenterIds, pairing it with the display name of its vCenter connection; the display name is the identifier itself when the connection has none

array of object
clusters
Required  

One entry per locator in parentLocators, pairing it with the cluster name resolved through the cluster name resolver; the name is the locator itself when no name is found


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisors/facets