Licensing Operations List Hosts

Licensing Operations List Hosts
Per-host core usage

Returns paginated per-host core usage with calculation details. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/licensing/hosts
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default 0). A negative page is clamped to 0, not rejected.

integer
pageSize
Optional
Constraints: minimum: 1 maximum: 200 default: 25

Number of items per page (default 25). A value outside 1 to 200 is clamped into that range, not rejected.

pageSize example
20
string
search
Optional

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.

search example
esx01.example.com
licensingStatus
Optional

Keeps only the hosts in this licensing status (CONSUMING, OFFLINE_WITHIN_THRESHOLD or RECLAIMED); omit it to list every host.

licensingStatus example
CONSUMING
string
sort
Optional

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.

sort example
chargedCores,desc

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of per-host core usage with the calculation details

Returns HostCoreUsagePage of type(s) application/json
{
    "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
}
array of object
items
Required  

Hosts on the requested page

integer As int32 As int32
page
Required  

Zero-based index of the returned page; a negative request is treated as 0

integer As int32 As int32
pageSize
Required  

Page size applied: the requested size limited to 1 through 200

integer As int64 As int64
totalItems
Required  

Total number of hosts after filtering, across all pages


400

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

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.


401

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

Returns Unauthenticated 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 InternalError 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/licensing/hosts