Get Action Status

Get the status of a requested action.

Synopsis

URI
/public_api/v1/actions/get_action_status/
HTTP Method
POST
Required License
Cortex XDR Prevent or Cortex XDR Pro per Endpoint

Description

Retrieve the status of the requested actions according to the action ID.

Request Fields

The body of this request contains a JSON object with the following fields:
Field
Description
request_data
(
Required
) A dictionary containing the API request fields.
group_action_id
(
Required
) String the represents the Action ID of the selected request.
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/actions/get_action_status/ \ -H "x-xdr-auth-id:{API_KEY_ID}" \ -H "Authorization:{API_KEY}" \ -H "Content-Type:application/json" \ -d '{ "request_data":{ "group_action_id":<action ID> } }'

Success Response

Upon success, the HTTP response code is 200.
Field
Description
reply
JSON object containing the query result.
  • data
    — Status of the action ID. Can be one of the following:
    • PENDING
    • IN_PROGRESS
    • CANCELLED
    • PENDING_ABORT
    • ABORTED
    • EXPIRED
    • COMPLETED_PARTIAL
    • COMPLETED_SUCCESSFULLY
    • FAILED
    • TIMEOUT
Success Response Example
{ "reply": { "data": { "<action ID>": "COMPLETED_SUCCESSFULLY", "<Action ID>": "IN_PROGRESS", "<Action ID>": "PENDING" } } }

Error Response

Upon error, the reply includes an HTTP response code, an error message, and additional information describing the error. The HTTP response code is one of the following:
Field
Description
400
Bad Request. Got an invalid JSON.
401
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
402
Unauthorized access. User does not have the required license type to run this API.
403
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
500
Internal server error. A unified status for API communication type errors.
Error Response Format
{"reply": {"err_code": STATUS_CODE, "err_msg": GENERAL_MESSAGE, "err_extra": EXTRA_DATA}}

Recommended For You