Rescan an uploaded file task (TAE)

Expand all | Collapse all

The /attribution/tasks/file/{task ID} endpoint is used to repeat a file execution task in Cloud Threat Attribution Engine.

Request

Request method: PUT

Endpoint: https://tip.kaspersky.com/api/attribution/tasks/file/{task_id}

Query parameters:

Expected parameters

Parameter

Description

task_id

Object execution task ID that you want to restart.

If necessary, you can change the object execution parameters. If the following parameters are not specified, previously specified values are used.

Optional expected parameters

Parameter

Description

file_name

Object name. Required parameter.

Specify a file name, which Kaspersky Threat Intelligence Portal must use during execution in Kaspersky Sandbox. The specified file name will be assigned to the uploaded file or the file contained in the uploaded archive.

For correct processing of the file, do not specify its extension in the file_name parameter: Kaspersky Threat Intelligence Portal automatically determines the file type, and processes the file accordingly.

The value must not exceed 240 characters.

processing_type

Object execution type. Available values:

exec-only—Object execution is performed.

unzip-and-exec—Object is unpacked before execution.

unzip_password

Password for an archived object.

This parameter is used only when processing_type = unzip-and-exec.

reset_similarity_thresholds

Specifies whether similarity thresholds for compared samples must be ignored. Available values:

true—Similarity thresholds are ignored.

false—Similarity thresholds are not ignored.

unpack

Specifies whether the contents of the executed file must be unpacked for analysis. Available values:

true—File will be unpacked.

false—File will not be unpacked.

Request example:

To rescan an uploaded and executed file:

curl -u <user name> --cert <full path to the certificate on your computer> -X PUT --header 'Content-Length: 0' 'https://tip.kaspersky.com/api/attribution/tasks/file/<task ID>'

Responses

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

451 Unavailable For Legal Reasons

Page top