Agent Commands Api List
Latest state per command type for the agent. Requires the ADMIN role.
Agent primary key
2
200 OK successful response envelope. The latest state per command type
{
"items": [
{
"agentPk": 2,
"type": "ActionConfigSync",
"status": "TIMED_OUT",
"commandId": 5,
"requestedBy": "bob.example",
"requestedAt": "2026-01-15T09:00:00Z",
"sentAt": "2026-01-15T09:00:01Z",
"completedAt": "2026-01-15T09:05:30Z",
"resultMessage": "No result received from the agent before the timeout"
},
{
"agentPk": 2,
"type": "ActionSetHeartbeatInterval",
"status": "SENT",
"commandId": 7,
"numericValue": 60,
"requestedBy": "bob.example",
"requestedAt": "2026-01-15T09:30:00Z",
"sentAt": "2026-01-15T09:30:01Z"
}
]
}
The latest command of each command type for the agent, ordered by command type; empty when no command was issued
400 Bad Request: INVALID_ARGUMENT when the agentPk path variable 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.
403 Forbidden: FORBIDDEN
{
"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: AGENT_NOT_FOUND
"ApiErrorResponse Object"
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/agents/{agentPk}/commands