API Reference

Scan a file

Uploads one file and synchronously runs content-type and malware analysis. Only the first multipart part named file with a filename is scanned; other parts are ignored. Free accounts accept files up to 50 MiB; Grow and Scale accounts accept files up to 250 MiB.

Authentication

X-API-Keystring

API key in the mak.<lookup-id>.<secret> format.

Request

This endpoint expects a multipart form containing a file.
filefileRequired
File content to scan. The part must include a filename.

Response headers

LocationstringOptional
Relative URL of the stored scan.

Response

The scan completed and was stored.
idstring

Server-generated scan identifier.

created_atdatetime
statusenum
verdictenum
filenamestring
Filename supplied by the multipart upload.
sha256stringformat: "^[0-9a-f]{64}$"
size_byteslong>=0
duration_msdouble>=0
failureobject or null

Failure information, or null when the scan completed.

detectionslist of strings
Detection names reported for the file. Empty when no threats were detected.
type_analysisobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error