Skip to main content
POST
Scan a file for malware

Scan file

Uploads a file to be scanned. The request is multipart/form-data.

Form fields

  • file (required): the file to scan
  • apikey (optional): alternative to the X-API-Key header
  • devicename (optional): alternative to the X-Device-Name header

Headers

X-API-Key
string

User API key for authentication

X-Device-Name
string

Name of the device making the request

Body

multipart/form-data
file
file
required

The file to scan

apikey
string

User API key (alternative to X-API-Key header)

devicename
string

Device name (alternative to X-Device-Name header)

Response

Scan completed successfully

detections
string[][]

List of detections found

Tuple of (antivirus_name, detection_name)

file_hash
object
has_detections
boolean

Whether any detections were found

metadata
object

File metadata extracted using exiftool and python-magic

num_detections
integer

Number of malware detections