How to Start an Analysis

After uploading a sample to the vxCube server, you can start its analysis. To do this, send the POST analyses request that includes the uploaded file ID and the desired platforms. You can find these parameter values in the API response for the file upload.

Example request

curl -X POST https://<IP address/domain name of the server>/api-2.0/analyses \

-H "Content-Type: application/json" \

-H "Authorization: api-key aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \

-d "{\"sample_id\":\"6784\", \"platforms\":[\"acrobat_7_32_11\", \"acrobat_7_64_15\"]}"

To start an analysis of a sample using network traffic redirection, send the following POST analyses request:

curl -X POST https://<IP address/domain name of the server>/api-2.0/analyses \

-H "Content-Type: application/json" \

-H "Authorization: api-key aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \

-d "{\"sample_id\":\"6784\", \"platforms\":[\"acrobat_7_32_11\", \"acrobat_7_64_15\",

\"net\": \"socks5://username:password@<proxyaddress>:1080?udp=on\"}"]}"

In response, you receive the Analysis object that contains general analysis information:

{

   "id": 6260,

   "sample_id": 6784,

   "size": 10881846,

   "sha1": "00a610100a3516f4d0daa33e7de317d2ddb6c2c6",

   "start_date": "2019-02-08T04:08:15.162343+00:00",

   "format_name": "pdf",

   "user_name": "example@drweb.com",

   "tasks": [{

       "message": null,

       "end_date": null,

       "platform_code": "acrobat_7_64_15",

       "maliciousness": null,

       "progress": 0,

       "id": 18676,

       "status": "in queue",

       "start_date": "2019-02-08T04:08:15.643122+00:00"

   }, {

       "message": null,

       "end_date": null,

       "platform_code": "acrobat_7_32_11",

       "maliciousness": null,

       "progress": 0,

       "id": 18675,

       "status": "in queue",

       "start_date": "2019-02-08T04:08:15.632924+00:00"

   }]

}