Groups Api Get Agent Command Status

Groups Api Get Agent Command Status
Get the rollout state of a Group's agent protection command

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.

Request
URI
GET
https://{api_host}/api/v1/groups/{id}/agent-commands
COPY
Path Parameters
integer
id
Required  

Security Group id

id example
1

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The command rollout counts for the Group

Returns GroupAgentProtectionCommandStatusDto of type(s) application/json
{
    "securityGroupId": 1,
    "agentDisabledStatus": false,
    "commandType": "ActionAgentEnable",
    "totalAgents": 2,
    "pending": 0,
    "sent": 0,
    "succeeded": 2,
    "failed": 0,
    "dispatchFailed": 0,
    "timedOut": 0,
    "notSent": 0
}
integer As int64 As int64
securityGroupId
Required  

Identifier of the Group

boolean
agentDisabledStatus
Required  

The Group's current agentDisabledStatus; it decides commandType

string
commandType
Optional

ActionAgentDisable or ActionAgentEnable

integer As int32 As int32
totalAgents
Required  

Number of the Group's agents that are not deleted

integer As int32 As int32
pending
Required  

Number of those agents whose latest command of commandType is in state PENDING

integer As int32 As int32
sent
Required  

Number of those agents whose latest command of commandType is in state SENT

integer As int32 As int32
succeeded
Required  

Number of those agents whose latest command of commandType is in state SUCCEEDED

integer As int32 As int32
failed
Required  

Number of those agents whose latest command of commandType is in state FAILED

integer As int32 As int32
dispatchFailed
Required  

Number of those agents whose latest command of commandType is in state DISPATCH_FAILED

integer As int32 As int32
timedOut
Required  

Number of those agents whose latest command of commandType is in state TIMED_OUT

integer As int32 As int32
notSent
Required  

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

400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number

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: FORBIDDEN

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.


404

404 Not Found: SECURITY_GROUP_NOT_FOUND

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/groups/{id}/agent-commands