Endpoints Operations List

Endpoints Operations List
List endpoints with pagination, filtering, and sorting

Returns a paginated collection of endpoint summaries matching query criteria. Accessible to every authenticated role.

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

Zero-based page index (default 0). A negative page answers 400 INVALID_PAGINATION; it is not clamped.

integer
pageSize
Optional
Constraints: minimum: 1 maximum: 100 default: 20

Number of items per page (default 20, 1 to 100). A value outside 1 to 100 answers 400 INVALID_PAGINATION; it is not clamped.

pageSize example
20
string
search
Optional

Case-insensitive substring search matching hostname or IP address

search example
esx02.example.com
commStatus
Optional

Filter by communication status: ONLINE, OFFLINE, or NOT_REPORTING for endpoints that have not reported any state yet. A comma-separated list matches any of its values, for example OFFLINE,NOT_REPORTING. Omit for no filtering. Upper-case values are the contract; the server also accepts any letter case.

commStatus example
OFFLINE,NOT_REPORTING
lifecycleState
Optional

Filter by lifecycle state (ACTIVE, OFFLINE, DELETED)

lifecycleState example
ACTIVE
string
groupId
Optional

Filter by associated security group ID

groupId example
1
string
excludeGroupId
Optional

Leave out the endpoints that belong to this security group ID, so a caller picking endpoints to add to a group pages through only those that are not already members (VTPSECA-495). Combines with every other filter by AND; omit for no exclusion.

excludeGroupId example
2
string
inventoryAssociation
Optional

CURRENT lists only Agents linked to a host in the current inventory; NOT_CURRENT lists only Agents with no such host (historical identities whose release this Console has not confirmed). Omit to list every Agent (the default, unchanged). Nothing is matched by IP address or hardware UUID.

inventoryAssociation example
CURRENT
Enumeration: CURRENT, NOT_CURRENT
policySyncState
Optional

Filter by policy synchronization state (GOOD, PENDING, ERROR), or NOT_REPORTING for endpoints that have not reported any state yet. A comma-separated list matches any of its values, for example PENDING,ERROR,NOT_REPORTING. A concrete state never matches an endpoint with no reported state unless NOT_REPORTING is also listed. The commStatus and policySyncState filters are combined with AND. Omit for no filtering. Upper-case values are the contract; the server also accepts any letter case.

policySyncState example
PENDING,ERROR,NOT_REPORTING
sortBy
Optional
Constraints: default: hostname

Field to sort by (default: hostname)

sortBy example
hostname
sortOrder
Optional
Constraints: default: ASC

Sort direction (default: ASC)

sortOrder example
ASC

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of endpoint summaries that match the filters

Returns PaginatedResponse_EndpointSummary of type(s) application/json
{
    "items": [
        {
            "id": "2",
            "hostname": "esx02.example.com",
            "ipAddress": "192.0.2.12",
            "macAddress": "00:00:5e:00:53:02",
            "agentVersion": "1.4.2",
            "inventoryAssociation": "CURRENT",
            "esxiVersion": "8.0.2",
            "lifecycleState": "ACTIVE",
            "commStatus": "ONLINE",
            "healthStatus": "OK",
            "policySyncState": "GOOD",
            "appliedPolicyVersion": 3,
            "agentDisabledStatus": false,
            "groupId": "1",
            "groupName": "Production Servers",
            "enforcementMode": "ENFORCE",
            "lastHeartbeatAt": "2026-01-15T09:29:30Z",
            "registeredAt": "2026-01-12T10:15:00Z"
        },
        {
            "id": "4",
            "hostname": "esx04.example.com",
            "ipAddress": "192.0.2.14",
            "macAddress": "00:00:5e:00:53:04",
            "agentVersion": "1.4.2",
            "inventoryAssociation": "NOT_CURRENT",
            "esxiVersion": "8.0.2",
            "lifecycleState": "ACTIVE",
            "commStatus": "OFFLINE",
            "healthStatus": "OK",
            "policySyncState": "GOOD",
            "appliedPolicyVersion": 3,
            "agentDisabledStatus": false,
            "groupId": "1",
            "groupName": "Production Servers",
            "enforcementMode": "ENFORCE",
            "lastHeartbeatAt": "2026-01-14T09:30:00Z",
            "registeredAt": "2026-01-12T10:15:00Z"
        }
    ],
    "page": 0,
    "pageSize": 25,
    "totalItems": 2,
    "totalPages": 1
}
array of object
items
Required  

Array of items for the current page

integer As int32 As int32
page
Required  
Constraints: minimum: 0

Zero-based current page number

integer As int32 As int32
pageSize
Required  
Constraints: minimum: 1 maximum: 100

Number of items requested per page

integer As int64 As int64
totalItems
Required  

Total number of items matching filter criteria

integer As int32 As int32
totalPages
Required  
Constraints: minimum: 0

Total number of available pages


400

400 Bad Request: INVALID_PAGINATION when page is negative or pageSize is outside 1 to 100; INVALID_FILTER when commStatus, lifecycleState, policySyncState, groupId or enforcementMode is not a valid value; INVALID_SORT when sortBy is not a sortable property or sortOrder is not ASC or DESC

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 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/endpoints