Dashboard Operations Get Summary

Dashboard Operations Get Summary
Hypervisor, configuration-sync and Security Group counts as one snapshot (any authenticated role)

Hypervisor and configuration-sync population is exactly what GET /api/v1/endpoints lists with no filters. connected + offline + unreported == managed; upToDate + pending + error + unreported == managed.

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

200 OK successful response envelope. The hypervisor and configuration-sync counts

Returns DashboardSummaryDto of type(s) application/json
{
    "asOf": "2026-01-15T10:00:00Z",
    "hypervisors": {
        "managed": 12,
        "connected": 9,
        "offline": 2,
        "unreported": 1
    },
    "groups": {
        "total": 2,
        "monitor": 1,
        "enforce": 1,
        "agentDisabled": 0
    },
    "configSync": {
        "upToDate": 9,
        "pending": 2,
        "error": 0,
        "unreported": 1
    }
}
string As date-time As date-time
asOf
Required  

Time the snapshot was taken (UTC)

object
hypervisors
Required  

Managed hypervisor counts over the population GET /api/v1/endpoints lists with no filters. connected + offline + unreported == managed.

object
groups
Required  

Security Group counts by configured mode, independent of runtime state

object
configSync
Required  

Policy synchronization counts over the same population as hypervisors. upToDate + pending + error + unreported == hypervisors.managed.


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.


500

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

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.


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