Endpoints Operations Get By Id
Returns full operational, inventory, policy, and health detail for the endpoint. Accessible to every authenticated role.
Unique external endpoint identifier (string-serialized 64-bit integer)
2
200 OK successful response envelope. The endpoint detail
{
"id": "2",
"hostname": "esx02.example.com",
"ipAddress": "192.0.2.12",
"macAddress": "00:00:5e:00:53:02",
"esxiVersion": "8.0.2",
"esxiBuild": "20000000",
"agentVersion": "1.4.2",
"lifecycleState": "ACTIVE",
"commStatus": "ONLINE",
"healthStatus": "OK",
"policySyncState": "GOOD",
"appliedPolicyVersion": 3,
"agentDisabledStatus": false,
"policyErrorCode": null,
"policyErrorDetail": null,
"failedRuleRef": null,
"policyAppliedAt": "2026-01-15T09:20:00Z",
"lastHeartbeatAt": "2026-01-15T09:29:30Z",
"missedHeartbeats": 0,
"groupId": "1",
"groupName": "Production Servers",
"enforcementMode": "ENFORCE",
"heartbeatIntervalSeconds": 300,
"eventsDropped": 0,
"spoolBytesUsed": 0,
"cpuPercent": 37,
"memoryPercent": 62,
"registeredAt": "2026-01-12T10:15:00Z",
"updatedAt": "2026-01-15T09:29:30Z",
"mfaVault": {
"state": "NOT_REQUIRED",
"version": null,
"credentialCount": null,
"detail": null,
"updatedAt": "2026-01-15T09:20:00Z"
}
}
Unique external endpoint identifier (string-serialized 64-bit ID)
Host name recorded for the endpoint's agent
Primary IP address of the endpoint
Primary MAC address of the endpoint
Host ESXi hypervisor version
Host ESXi build number/string
Installed VTP agent version
Administrative lifecycle state of the endpoint
ACTIVE: The endpoint is registered and has heartbeated; the default stored state, also set again by the next heartbeat of an OFFLINE endpointOFFLINE: The state stored when the endpoint is enrolled, until its first heartbeatDELETED: The endpoint was retired by the Console; a retired endpoint no longer counts toward catalogued files' host counts
Communication status recorded for the agent; set ONLINE by each heartbeat and OFFLINE by the Console when the host is marked offline; null when no agent state exists
Agent health taken from the status the agent reported in its last heartbeat; null when no agent state exists
Whether the agent holds the policy of its current Security Group; null when no agent state exists, which is the Not reporting set that the policySyncState=NOT_REPORTING list filter returns
Policy version of the Security Group the agent last reported as applied, as recorded by the rules sync; null when no agent state exists
Whether this endpoint's agent is currently in the dormant "circuit breaker" state (rule evaluation unhooked entirely)
Error code if policy application failed
Error detail message if policy application failed
External reference of rule that failed policy application
Timestamp when policy was applied on the endpoint as an ISO 8601 date-time with offset
Last successful heartbeat timestamp as an ISO 8601 date-time with offset
Consecutive missed heartbeat count
Associated security group identifier
Associated security group display name
Active enforcement mode of the endpoint's assigned Security Group
Security group configured heartbeat interval in seconds
Count of dropped events reported by agent
Spool storage bytes used on endpoint
CPU utilization percentage reported by agent
Memory utilization percentage reported by agent
Timestamp when the endpoint first registered as an ISO 8601 date-time with offset
Timestamp when the endpoint record was last updated as an ISO 8601 date-time with offset
Applied status of the SSH MFA vault. The detail is a reason code or the Agent's truncated failure text and never contains secret material. Null only when no AgentState row exists yet.
400 Bad Request: INVALID_ENDPOINT_ID when the id is blank or is not a number
{
"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.
404 Not Found: ENDPOINT_NOT_FOUND when no endpoint has the id
{
"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/endpoints/{id}