Groups Api Get Agent Command Status
Counts, per delivery state, the agents of the Group that were sent the agent disable or enable command. Requires the ADMIN or SECURITY_OPERATOR role.
Security Group id
1
200 OK successful response envelope. The command rollout counts for the Group
{
"securityGroupId": 1,
"agentDisabledStatus": false,
"commandType": "ActionAgentEnable",
"totalAgents": 2,
"pending": 0,
"sent": 0,
"succeeded": 2,
"failed": 0,
"dispatchFailed": 0,
"timedOut": 0,
"notSent": 0
}
Identifier of the Group
The Group's current agentDisabledStatus; it decides commandType
ActionAgentDisable or ActionAgentEnable
Number of the Group's agents that are not deleted
Number of those agents whose latest command of commandType is in state PENDING
Number of those agents whose latest command of commandType is in state SENT
Number of those agents whose latest command of commandType is in state SUCCEEDED
Number of those agents whose latest command of commandType is in state FAILED
Number of those agents whose latest command of commandType is in state DISPATCH_FAILED
Number of those agents whose latest command of commandType is in state TIMED_OUT
Number of the Group's agents with no recorded command of commandType: totalAgents minus the agents counted in the six states, never below 0
400 Bad Request: INVALID_ARGUMENT when the id 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: SECURITY_GROUP_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/groups/{id}/agent-commands