Check file retrieval status from device

Check the status of a previously requested file retrieval operation.

Service endpoint

/devicecommands/v2/{{device_id}}/getfile:get

Optional query string parameters

—

Example

https://protectapi.cylance.com/devicecommands/v2/45E07F34E76B4A9EB167D6D0C510D6BA/getfile:get

Method

HTTP/1.1 POST

Request headers
  • Accept: application/json
  • Authorization: Bearer JWT Token returned by Auth API with the opticscommand:read scope encoded
Note: The format of the device ID must be in all caps with no hyphens.

Request

JSON 
{
    "file_path": "C:\path\to\file.txt"
}

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name Description

data

This is an object containing the various fields associated with the file retrieval request.

tenant_id

This is the unique tenant ID of the tenant that the device belongs to.

user_id

This is the unique ID of the user who locked down the device.

device_id

This is the unique device ID that the lockdown command was issued to. See About device ID for device ID formatting.

created_at

This is the timestamp (in UTC) of when the file retrieval was requested.

filepath

This is the file path of the requested file.

download_url

This is the unique URL and parameters required to download the retrieved file.

file_status

This is the status of the file retrieval. This will always be "PENDING" for newly created file retrievals.

  • REQUEST: The file retrieval has not been requested, but the user may issue a request for it.
  • RETRY_REQUEST: The file retrieval has been requested previously but no results were received. It can be requested again.
  • PENDING: The file retrieval has been requested but has not yet been completed.
  • DOES_NOT_EXIST: The file retrieval has been requested but is not present on the device.
  • AVAILABLE:  The file is available for download. A download link (download_url) is generated and valid for the next 10 minutes.
  • UNAVAILABLE: The file is not available. This status may indicate that the requested device is not online, or the requested device failed to upload the file. This status will become RETRY_REQUEST after an hour.

file_status_description

This displays any errors or status messages associated with the retrieval request.

password

This is the password required to decrypt the retrieved file.

md5

This is the MD5 hash of the retrieved file.

sha1

This is the SHA1 hash of the retrieved file.

sha256

This is the SHA256 hash of the retrieved file.

correlation_id

This is the correlation ID associated with this action.

user_login

This is the email address of the user who initiated the file retrieval request.

hostname

This is the hostname of the device that the file retrieval was requested on.