Hypervisors Api List Hypervisors
Lists hypervisors of every management type, paginated, filterable and sortable. Accessible to every authenticated role.
Zero-based page index (default 0). A negative page answers 400 INVALID_PAGINATION; it is not clamped.
Number of items per page (default 20, 1 to 100). A value outside 1 to 100 answers 400 INVALID_PAGINATION; it is not clamped.
20
Case-insensitive substring search
esx02.example.com
Only hosts of this vCenter connection
db-1
Only hosts under this parent locator (cluster)
domain-c8
Filter by connection state
CONNECTED
Filter by inventory state
ACTIVE
Filter by agent VIB status
INSTALLED
Filter by enrollment status
NOT_ENROLLED
Sort field (default hostname): hostname, vcenterId, parentLocator, esxiVersion, connectionState or observedAt. Any other value answers 400 INVALID_SORT. A secondary sort on the hypervisor key is always applied.
hostname
Sort direction, ASC or DESC (default ASC). Any other value answers 400 INVALID_SORT.
ASC
200 OK successful response envelope. A page of hypervisors
{
"items": [
{
"id": "102",
"vcenterId": "db-1",
"hostname": "esx02.example.com",
"parentLocator": "domain-c8",
"connectionState": "CONNECTED",
"inMaintenanceMode": false,
"esxiVersion": "8.0.2",
"esxiBuild": "20000000",
"inventoryState": "ACTIVE",
"stale": false,
"observedAt": "2026-01-15T09:30:00Z",
"firstObservedAt": "2026-01-10T08:00:00Z",
"agentCorrelationState": "CORRELATED",
"vcenterConnectionId": "db-1",
"vcenterInstanceUuid": "00000000-0000-4000-8000-000000000021",
"hardwareUuid": "00000000-0000-4000-8000-000000000022",
"vcenterDisplayName": "Primary vCenter",
"agentId": "2",
"enrollmentStatus": "ENROLLED",
"enrolledAt": "2026-01-12T10:15:00Z",
"enrollmentError": null,
"agentVibStatus": "INSTALLED",
"agentVibIdentifier": "vtpsecurityagent",
"agentVibVersion": "1.4.2",
"agentVibDisplayName": "VTP Security Agent",
"enrollmentStage": "ENROLLED",
"agentCommStatus": "ONLINE",
"lastHeartbeatAt": "2026-01-15T09:29:30Z",
"clusterName": "Production Cluster",
"managementType": "VCENTER_MANAGED",
"autoEnrollSuppressedAt": null,
"authUsername": null,
"hardwareIdentityConflict": false,
"agentVibConfirmedAt": "2026-03-10T08:00:00Z",
"agentVibLastAttemptAt": "2026-03-10T08:00:00Z",
"agentVibLastAttemptResult": "OK",
"recoveryRequired": false,
"recoveryReason": null
},
{
"id": "101",
"vcenterId": null,
"hostname": "esx01.example.com",
"parentLocator": null,
"connectionState": "CONNECTED",
"inMaintenanceMode": false,
"esxiVersion": "8.0.2",
"esxiBuild": "20000000",
"inventoryState": "ACTIVE",
"stale": false,
"observedAt": "2026-01-15T09:30:00Z",
"firstObservedAt": "2026-01-15T09:30:00Z",
"agentCorrelationState": "NOT_CORRELATED",
"vcenterConnectionId": null,
"vcenterInstanceUuid": null,
"hardwareUuid": "00000000-0000-4000-8000-000000000011",
"vcenterDisplayName": "Standalone ESXi",
"agentId": null,
"enrollmentStatus": "NOT_ENROLLED",
"enrolledAt": null,
"enrollmentError": null,
"agentVibStatus": "UNKNOWN",
"agentVibIdentifier": null,
"agentVibVersion": null,
"agentVibDisplayName": null,
"enrollmentStage": "NONE",
"agentCommStatus": null,
"lastHeartbeatAt": null,
"clusterName": null,
"managementType": "STANDALONE",
"autoEnrollSuppressedAt": null,
"authUsername": null,
"hardwareIdentityConflict": false,
"agentVibConfirmedAt": null,
"agentVibLastAttemptAt": null,
"agentVibLastAttemptResult": null,
"recoveryRequired": false,
"recoveryReason": null
}
],
"page": 0,
"pageSize": 20,
"totalItems": 2,
"totalPages": 1
}
Array of items for the current page
Zero-based current page number
Number of items requested per page
Total number of items matching filter criteria
Total number of available pages
400 Bad Request: INVALID_PAGINATION, INVALID_FILTER or INVALID_SORT
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisors