Scanning objects

Objects are scanned using the POST method.

Syntax

POST "sample=<path to the object> <URL of the Sandbox server>/sandbox/v1/tasks"

Example

curl -X POST https://api.example.com/sandbox/v1/tasks -F "sample=@/path/to/file.ext"

Returned value

Return code

Description

200

This file has already been scanned.

Possible values:

  • Not found: signs of malicious objects were not detected.
  • Found: signs of malicious objects were detected.

201

File successfully submitted for scanning. Identifier assigned to the task: task_id.

400

Invalid request.

500

Could not submit the file for scanning due to one of the following reasons:

  • No license key installed.
  • File size limit exceeded (60 MB).
  • File format not supported.
  • Request queue full.
  • Unknown error.

503

Server unavailable. Try to connect to a different server or try again later.

504

Server timeout. Try to connect to a different server or try again later.

Page top