Deployment Operations Get Summary

Deployment Operations Get Summary
Fleet rollout and enrollment summary (Administrator, Security Operator or Auditor)

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.

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

200 OK successful response envelope. One snapshot of the deployment totals

Returns DeploymentSummaryDto of type(s) application/json
{
    "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
}
string As date-time As date-time
asOf
Required  

Time the snapshot was taken (UTC)

integer As int64 As int64
enrollmentDeadlineSeconds
Required  

Enrollment heartbeat deadline used for the pending/failed projection

integer As int64 As int64
inventoryFreshnessMinutes
Required  

Discovery freshness threshold used for inventory.stale

object
totals
Required  

Counts over one set of distinct hypervisors

array of object
agentVersions
Required  

Most hosts first, then by version; the unreported version last

array of object
rows
Required  

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

integer As int64 As int64
outOfScopeHypervisors
Required  

Hosts whose stored vCenter connection reference matches no configured connection; not in totals

integer As int64 As int64
staleInventoryExcluded
Required  

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

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

Returns ApiErrorResponse 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.


403

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)

Returns ApiErrorResponse 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.


500

500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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/deployment/summary