Close Scan Batch

Url

/file/batch/<batch_id>/close

Method

POST

Header

Description

apikey (OPTIONAL)

User's session id, if it was set for creation it is required

Result Code

Description

200

Batch closed successfully

400

Bad request, (e.g.: wrong header values)

403

Access denied

404

Batch not found

500

Internal server error

HTTP status code: 200

Note that "files_in_batch" list maximum 50 results by default, and it is pagination controlled by "first" and "size" parameter.

For example: /file/batch/<batch_id>/first=50&size=100

{
"batch_files":{
"batch_count":4,
"files_in_batch":[
{
"data_id":"24c8b5dadd48445989ac3431544fdc34",
"detected_by":4,
"display_name":"eicar.com",
"file_size":68,
"file_type":"application/octet-stream",
"file_type_description":"EICAR virus test files",
"process_info":{
"blocked_reason":"Infected",
"progress_percentage":100,
"result":"Blocked",
"verdicts":[
"Infected"
]
},
"progress_percentage":100,
"scan_all_result_a":"Infected",
"scan_all_result_i":1,
"scanned_with":4
},
{
"data_id":"4bfb5dff13084d909f1afc97353cfca8",
"detected_by":0,
"display_name":"windows-database.yml",
"file_size":2205,
"file_type":"text/plain",
"file_type_description":"ASCII Text",
"process_info":{
"blocked_reason":"",
"progress_percentage":100,
"result":"Allowed",
"verdicts":[
"No Threat Detected"
]
},
"progress_percentage":100,
"scan_all_result_a":"No Threat Detected",
"scan_all_result_i":0,
"scanned_with":4
},
{
"data_id":"cdab9c5089994091babe5a1fc16e5a69",
"detected_by":0,
"display_name":"ChromeSetup.exe",
"file_size":1214008,
"file_type":"application/x-dosexec",
"file_type_description":"Executable File",
"process_info":{
"blocked_reason":"",
"progress_percentage":100,
"result":"Allowed",
"verdicts":[
"No Threat Detected"
]
},
"progress_percentage":100,
"scan_all_result_a":"No Threat Detected",
"scan_all_result_i":0,
"scanned_with":4
},
{
"data_id":"8c29974a819d41eb8c5c9a9418e0d600",
"detected_by":0,
"display_name":"install-2.4.4.exe",
"file_size":3476784,
"file_type":"application/x-dosexec",
"file_type_description":"Self-extracting Executable File",
"files_extracted_count":50,
"process_info":{
"blocked_reason":"",
"progress_percentage":100,
"result":"Allowed",
"verdicts":[
"No Threat Detected"
]
},
"progress_percentage":100,
"scan_all_result_a":"No Threat Detected",
"scan_all_result_i":0,
"scanned_with":4
}
],
"first_index":0,
"page_size":50
},
"batch_id":"b7cc760038324b02908a5c111cb1563d",
"is_closed":false,
"process_info":{
"blocked_reason":"Infected",
"file_type_skipped_scan":false,
"profile":"File process",
"result":"Blocked",
"user_agent":"mdicapserver",
"username": "LOCAL/admin"
},
"scan_results":{
"batch_id":"b7cc760038324b02908a5c111cb1563d",
"scan_all_result_a":"Infected",
"scan_all_result_i":1,
"start_time":"2019-07-29T12:19:46.118Z",
"total_avs":0,
"total_time":18403
},
"user_data":"http://localhost:8008/"
}

HTTP status code: 500, 403, 400

{
"err": <error message>
}