post
/public_api/v1/actions/get_action_status
Retrieve the status of the requested actions according to the action ID.
Required license: Cortex XDR Prevent, Cortex XDR Pro per Endpoint, or Cortex XDR Pro per GB
CURL
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://api-yourfqdn/public_api/v1/actions/get_action_status" \
-d '{
"request_data" : {
"group_action_id" : 0
}
}'
Response
{
"reply": {
"data": {
"<agent ID>": "COMPLETED_SUCCESSFULLY"
}
}
}
Request
Body
optional
Example:
{"request_data":{"group_action_id":""}}
request_data
required
A dictionary containing the API request fields.
group_action_id
required
Integer
Action ID of the selected request.
Responses
Successful response
Body
reply
optional
JSON object containing the query result.
data
optional
agent_id
optional
String
(Enum)
Allowed values:
PENDING
IN_PROGRESS
CANCELLED
PENDING_ABORT
ABORTED
EXPIRED
COMPLETED_PARTIAL
COMPLETED_SUCCESSFULLY
FAILED
TIMEOUT
Bad Request. Got an invalid JSON.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Unauthorized access. User does not have the required license type to run this API.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.
Internal server error. A unified status for API communication type errors.
Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
Example:
{"line": 1, "column": 19, "message": "no viable alternative at input '|alter2'"}
err_extra
optional
String
Additional information describing the error.