Communication key
URL to be analyzed
https://example.comDetermines if the scan should be private
falseSuccessful analysis
No content
Bad Request - Invalid URL or body
Unauthorized
No content
Communication key
If this passed as "true", all of the metafields and environment will be set automatically
falseFile to be analyzed
Make a MIMEType check for the file and auto-assign the extension
trueModules to be used in analysis
["csi","cdr"]Select the file to be executed within the archive
file.exeEnter the password that will be used to open the archive file
passwordSuccessful analysis
No content
Unauthorized
Unprocessable Entity - Invalid file or body
No content
This endpoint allows users to upload a file and perform a static scan on it.
Communication key
The file to be scanned
Option to check file extension
Whether the scan results should be public
Select the file to be executed within the archive
file.exeEnter the password that will be used to open the archive file
passwordThe file has been successfully scanned
No content
Unauthorized
Unprocessable Entity - Invalid file or body
No content
This endpoint allows users to upload a file and perform a CDR scan on it, extension check is not optional because it is necessary for CDR module to work properly.
Communication key
The file to be scanned
Whether the scan results should be public
Select the file to be executed within the archive
file.exeEnter the password that will be used to open the archive file
passwordThe file has been successfully submitted for CDR
Unauthorized
Unprocessable Entity - Invalid file or body
POST /public-api/scan/url-analysis HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"url": "https://example.com",
"private": false
}POST /public-api/scan/sandbox HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 671
{
"file": "binary",
"analyzeConfig": [
{
"metafieldId": "environment",
"value": "w10_x64"
},
{
"metafieldId": "private",
"value": false
},
{
"metafieldId": "timeout",
"value": 180
},
{
"metafieldId": "work_path",
"value": "desktop"
},
{
"metafieldId": "mouse_simulation",
"value": true
},
{
"metafieldId": "https_inspection",
"value": false
},
{
"metafieldId": "internet_connection",
"value": false
},
{
"metafieldId": "raw_logs",
"value": false
},
{
"metafieldId": "snapshot",
"value": false
},
{
"metafieldId": "sleep_evasion",
"value": false
},
{
"metafieldId": "smart_tracing",
"value": false
},
{
"metafieldId": "dump_collector",
"value": false
}
],
"extensionCheck": "true",
"modules": [
"csi",
"cdr"
],
"entrypoint": "file.exe",
"password": "password"
}POST /public-api/scan/static-scan HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 103
{
"file": "binary",
"extensionCheck": "text",
"isPublic": true,
"entrypoint": "file.exe",
"password": "password"
}POST /public-api/scan/cdr HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 79
{
"file": "binary",
"isPublic": true,
"entrypoint": "file.exe",
"password": "password"
}{
"message": "text",
"uuid": "text"
}