Deployment Operations Get Summary
One snapshot over standalone hosts plus hosts whose stored vCenter connection reference belongs to a configured connection (the Discover membership rule, also when no connection exists). Never contacts vCenter or ESXi and never writes. Every totals field equals the sum over rows; agentVersions sums to totals.agentRollout.installed.
200 OK successful response envelope. One snapshot of the deployment totals
{
"asOf": "2026-01-15T10:00:00Z",
"enrollmentDeadlineSeconds": 600,
"inventoryFreshnessMinutes": 15,
"totals": {
"hypervisors": 3,
"agentRollout": {
"installed": 1,
"notInstalled": 1,
"unknown": 1,
"queryFailed": 0
},
"enrollment": {
"enrolled": 2,
"pending": 0,
"failed": 0,
"notEnrolled": 1,
"oldestPendingSince": null
},
"needsAttention": {
"hypervisors": 0,
"enrollmentFailed": 0,
"recoveryRequired": 0,
"vibReconciliation": 0
},
"inventory": {
"stale": 0,
"sharedHardwareUuid": 0,
"lastObservedAt": "2026-01-15T09:59:00Z",
"lastVibQueriedAt": "2026-01-15T09:45:00Z"
}
},
"agentVersions": [
{
"version": "1.4.2",
"hypervisors": 1
}
],
"rows": [
{
"kind": "VCENTER",
"vcenterConnectionId": "db-1",
"displayName": "Primary vCenter",
"connectionReferences": [
"db-1"
],
"counts": {
"hypervisors": 2,
"agentRollout": {
"installed": 1,
"notInstalled": 1,
"unknown": 0,
"queryFailed": 0
},
"enrollment": {
"enrolled": 1,
"pending": 0,
"failed": 0,
"notEnrolled": 1,
"oldestPendingSince": null
},
"needsAttention": {
"hypervisors": 0,
"enrollmentFailed": 0,
"recoveryRequired": 0,
"vibReconciliation": 0
},
"inventory": {
"stale": 0,
"sharedHardwareUuid": 0,
"lastObservedAt": "2026-01-15T09:58:00Z",
"lastVibQueriedAt": "2026-01-15T09:45:00Z"
}
}
},
{
"kind": "STANDALONE",
"vcenterConnectionId": null,
"displayName": null,
"connectionReferences": [],
"counts": {
"hypervisors": 1,
"agentRollout": {
"installed": 0,
"notInstalled": 0,
"unknown": 1,
"queryFailed": 0
},
"enrollment": {
"enrolled": 1,
"pending": 0,
"failed": 0,
"notEnrolled": 0,
"oldestPendingSince": null
},
"needsAttention": {
"hypervisors": 0,
"enrollmentFailed": 0,
"recoveryRequired": 0,
"vibReconciliation": 0
},
"inventory": {
"stale": 0,
"sharedHardwareUuid": 0,
"lastObservedAt": "2026-01-15T09:59:00Z",
"lastVibQueriedAt": null
}
}
}
],
"outOfScopeHypervisors": 0,
"staleInventoryExcluded": 0
}
Time the snapshot was taken (UTC)
Enrollment heartbeat deadline used for the pending/failed projection
Discovery freshness threshold used for inventory.stale
Counts over one set of distinct hypervisors
Most hosts first, then by version; the unreported version last
One entry per management source: vCenter connections first (by display name, ignoring case), then UNRESOLVED references in reference order, then one STANDALONE row when standalone hosts exist
Hosts whose stored vCenter connection reference matches no configured connection; not in totals
Hosts of a configured connection whose inventoryState is STALE (retired by their vCenter source); not in totals, the same as the default Discover list. Standalone hosts are never excluded. Unrelated to inventory.stale (observation freshness).
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.
403 Forbidden: PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"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.
500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail
"ApiErrorResponse Object"
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/deployment/summary