Retrieve File

Retrieve files from endpoints.

Synopsis

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

Description

Retrieve files from selected endpoints. You can retrieve up to 20 files, from no more than 10 endpoints.
  • Response is concatenated using
    AND
    condition (OR is not supported).
  • Offset
    is the zero-based number of incidents from the start of the result set.

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.
filters
(
Required
) Provides an array of filtered fields. Each JSON object must contain the following keywords:
  • field
    String that identifies a list the filters match. Filters are based on the following keywords:
    • endpoint_id_list
      —List of endpoint IDs.
  • operator
    String that identifies the comparison operator you want to use for this filter. Valid keywords and values are:
    in
    • endpoint_id_list
      —List of strings
  • value
    Value that this filter must match. Valid keywords:
    • endpoint_id_list
      —List of strings
files
(
Required
) A dictionary containing the type of platform and files you want to retrieve. Valid keywords are:
  • windows
  • linux
  • macos
Valid value, list of strings:
file_path
.
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/endpoints/file_retrieval/ \ -H "x-xdr-auth-id:{API_KEY_ID}" \ -H "Authorization:{API_KEY}" \ -H "Content-Type:application/json" \ -d '{ "request_data":{ "filters":[ { "field":"endpoint_id_list", "operator":"in", "value":[ "<endpoint ID 1>", "<endpoint ID 2>", "<endpoint ID 3>" ] } ], "files":{ "windows":[ "C:\\<file path>\\test.txt" ] } } }'

Success Response

Upon success, the HTTP response code is 200.
Field
Description
reply
JSON object containing the query result.
action_id
ID of action to retrieve files from selected endpoints.
Response only indicates the request was successfully sent to the endpoint. To track if the file was retrieved successfully either: in the Cortex XDR console, navigate to
Response
Action Center
Isolation
and search for the action ID. Make sure the
Action ID
field is selected in the table
Layout
settings by selecting ( table-settings.png ).
To view the file, send a File Retrieval Details request.
status
Integer representing whether the action:
  • 1
    —succeeded
  • 0
    —failed
endpoints_count
Number of endpoints included in the request.
Success Response Example
{ "reply": { "action_id":"<action ID>", "status": "1", "endpoints_count": "673" } }

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