File Retrieval Details

post /public_api/v1/actions/file_retrieval_details

``` curl curl -XPOST "https://api-{fqdn}/public_api/v1/download/" -H "x-xdr-auth-id:{API_KEY_ID}" -H "Authorization:{API_KEY}" -H 'Content-Type:application/json' --output /tmp/file.zip ``` 2. Unzip the file: `unzip /tmp/file.zip`

View the API required to call in order to download the file retrieved by the Retrieve File API request according to the action ID.

Required license: Cortex XDR Prevent, Cortex XDR Pro per Endpoint, or Cortex XDR Pro per GB

The response contains a file hash you need to download and then unzip to view: 1. Download the file.

CURL

  curl -X POST \

-H "Accept: application/json" \
 -H "Content-Type: application/json" \
"https://api-yourfqdn/public_api/v1/actions/file_retrieval_details" \
 -d '{
  "request_data" : {
    "group_action_id" : "group_action_id"
  }
}'
  

Request

Body

optional

Example: {"request_data":{"group_action_id":""}}

request_data

required

A dictionary containing the API request fields.

group_action_id

required

String

The action ID of the Retrieve File API response.

Responses

Successful response

Body

optional

data

optional

endpoint_ID

optional

String

API required to call in order to download the retrieved result.

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.