Get Quarantine Status
Get the quarantine status of a file.
Synopsis
URI | /public_api/v1/quarantine/status/ |
HTTP Method | POST |
Required License | Cortex XDR Prevent,
Cortex XDR Pro per Endpoint, or Cortex XDR Pro per TB |
Description
Retrieve the quarantine status
for a selected file.
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. |
files | ( Required ) JSON object containing
the following keywords:
|
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/quarantine/status/ \ -H "x-xdr-auth-id:{API_KEY_ID}" \ -H "Authorization:{API_KEY}" \ -H "Content-Type:application/json" \ -d '{ "request_data": { "files": [ { "endpoint_id": "<endpoint ID>", "file_path": "C:\\<file path>\\test_x64.msi", "file_hash": "<hash value>" } ] } }'
Success Response
Upon success,
the HTTP response code is 200.
Field | Description |
|---|---|
reply | JSON object containing the query result. |
file_hash | String that represents the file hash. |
file_path | String that represents the file path. |
endpoint-_id | String that represents the endpoint ID. |
status | String that represents the status; True or False . |
Success Response Example
{ "reply":[ { "endpoint_id":"<endpoint ID>", "file_path":"C:\\<file path>\\test_x64.msi", "file_hash":"<hash value>", "status":false } ] }
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}}
Most Popular
Recommended For You
Recommended Videos
Recommended videos not found.
