This URL checks the analysis status.
Resource URL
GET https://<TIS_IP>/php/samplestatus.php
This URL takes iTaskId or jobId
iTaskId Parameter:
The iTaskId must be previously returned value in the File/URL submission step.
Retrieve the istate or status value from the response of samplestatus.php.
When analysis is complete, the istate=1 or 2.
When sample is waiting in the queue, the istate=4.
When sample is being analyzed, the istate=3.
When analysis is failed, istate=-1.
Only when the istate=1 or 2, continue to get the results.
Input parameters
Input parameter | Description | Data type |
|---|---|---|
| This is the returned iTaskId value in the submission step. | Number |
Output parameters
Output parameter | Description | Data type |
|---|---|---|
| Success is true if the request is processed successfully else false. | String |
| Task ID of the submitted sample file. | Numeric |
| istate is a numeric value as explained above. | Numeric |
| Current status of the sample. Example: waiting / analyzing / completed. | String |
| Name of the sample file. | String |
| The MD5 hash value of the sample file as calculated by . | Hexadecimal |
| The internally assigned ID for the VM Profile that was used. | Numeric |
| Job ID of the submitted sample file. | Numeric |
| Time when the sample was uploaded for analysis. | Timestamp |
| Summary file available. This field is valid only when istate is either 1 or 2. | |
| User logs available. This field is valid only when istate is either 1 or 2. | |
| Disassembly result available. This field is valid only when istate is either 1 or 2. | |
| PE information available. This field is valid only when istate is either 1 or 2. | |
| Family similarity available. This field is valid only when istate is either 1 or 2. | |
| User ID through which the files are submitted. | |
| VM name based on the operating system that was used for dynamic analysis. | String |
| The user-provided description for the analyzer VM that was used for dynamic analysis. | String |
jobId Parameter:
When jobId is passed as parameter, output json response contains only one parameter 'status' and it contains below values.
5 — completed
3 — analyzing
2 — waiting
-1 — failed
0 — sample submitted but taskid not generated yet
When jobId for a zip file is passed as parameter then the status value in the json is the minimum value of status of individual samples in the zip file.
When jobId is passed as parameter, output json response contains parameter 'allEngineState' and it contains below values.
1 — The sample is analyzed on all VMs submitted.
0 — The analysis is failed or canceled in any of the VMs submitted.
Note
When archive samples are sent for extraction and analysis, the overall verdict of the sample is the highest reported severity for the extracted contents. However, if the highest severity happens to be less than 3 and if one of the files within the archive sample is failed to be analyzed, then the overall verdict of the sample would be Failed (-2).
Example
Input
https://<TIS_IP>/php/samplestatus.php?iTaskId=52
Output
{"success":true, "results":{"userid":1,"taskid":52,"istate":3,"status":"Analyzing",
"filename":"mv0107-2.exe","md5":"b01f5c6b23f5073228aa6d1e05579be4","vmProfile":"1","jobid":
55,
"submitTime":"2013-03-02 10:08:47","summaryFiles":"0","useLogs":"0",
"asmListing":"0","PEInfo":"0",
"family":"0","vmName":"Win-XP-SP3-32bit","vmDesc":"XP SP3 32-bit with all reports"} }
Input
https://<TIS_IP>/php/samplestatus.php?jobId=69
Output
{'status': 5, 'allEngineState': 1, 'severity': 5, 'success': 'true'}