Licensing Operations List Hosts
Returns paginated per-host core usage with calculation details. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.
Zero-based page index (default 0). A negative page is clamped to 0, not rejected.
Number of items per page (default 25). A value outside 1 to 200 is clamped into that range, not rejected.
20
Case-insensitive substring match on the hostname, the agent identifier or the vCenter of a host. Surrounding blanks are ignored and a blank value applies no filter.
esx01.example.com
Keeps only the hosts in this licensing status (CONSUMING, OFFLINE_WITHIN_THRESHOLD or RECLAIMED); omit it to list every host.
CONSUMING
Sort spec field or field,direction. Fields: hostname (default), chargedCores or licensingStatus, matched case-insensitively; direction asc (default) or desc. Any other field falls back to hostname without an error.
chargedCores,desc
200 OK successful response envelope. A page of per-host core usage with the calculation details
{
"items": [
{
"agentId": "2",
"hostname": "esx02.example.com",
"vcenter": "db-1",
"cpuPackages": 2,
"physicalCores": 32,
"topologyKnown": true,
"minimumApplied": false,
"chargedCores": 32,
"lastCheckInAt": "2026-01-15T09:29:30Z",
"licensingStatus": "CONSUMING"
},
{
"agentId": "4",
"hostname": "esx04.example.com",
"vcenter": "db-1",
"cpuPackages": 1,
"physicalCores": 8,
"topologyKnown": true,
"minimumApplied": true,
"chargedCores": 16,
"lastCheckInAt": "2026-01-14T09:30:00Z",
"licensingStatus": "OFFLINE_WITHIN_THRESHOLD"
}
],
"page": 0,
"pageSize": 25,
"totalItems": 2
}
Hosts on the requested page
Zero-based index of the returned page; a negative request is treated as 0
Page size applied: the requested size limited to 1 through 200
Total number of hosts after filtering, across all pages
400 Bad Request: INVALID_ARGUMENT when licensingStatus is not a known status or page or pageSize is not a number; a page or pageSize outside its range is corrected, not rejected
{
"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.
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
{
"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/licensing/hosts