8.1.3.2.2.1. Archive file result (all child files in one response)

This endpoint API is not recommended to use against big archive file (contains numerous child files inside recursively), otherwise expecting to have performance degradation on the product.

It is highly recommended to use 8.1.3.2.2.2. Archive file result (pagination fashion) instead.

Retrieving Analysis Reports Using Data ID containing all files in archive

Using this method under extracted_files key all the info about extracted files will be listed recursively.

Request

Value

Method

GET

URL

/archive/{data_id}

Successful response containing all extracted files

HTTP status code: 200

{
"data_id": "8a8150d5b2aa4367be44f4a19c8dbb57",
"dlp_info": {},
"file_info": {
"display_name": "testzip.zip",
"file_size": 480,
"file_type": "application/zip",
"file_type_description": "ZIP Archive",
"md5": "0197200212f86efb5ac23150feab45c0",
"sha1": "084b89478b099a98971f62dc3aacbf3f7808d1a4",
"sha256": "9f6e906a3c4c8581687a63fb768bca244081e9940dc43a07a9cc6cb073e1a52a",
"upload_timestamp": "2019-03-25T07:48:25.003Z"
},
"process_info": {
"blocked_reason": "",
"file_type_skipped_scan": false,
"post_processing": {
"actions_failed": "",
"actions_ran": "",
"converted_destination": "",
"converted_to": "",
"copy_move_destination": ""
},
"processing_time": 79,
"profile": "File process",
"progress_percentage": 100,
"queue_time": 3,
"result": "Allowed",
"user_agent": "webscan",
"username": "LOCAL/admin",
"verdicts": [
"No Threat Detected"
]
},
"scan_results": {
"data_id": "8a8150d5b2aa4367be44f4a19c8dbb57",
"progress_percentage": 100,
"scan_all_result_a": "No Threat Detected",
"scan_all_result_i": 0,
"scan_details": {},
"start_time": "2019-03-25T07:48:25.006Z",
"total_avs": 1,
"total_time": 76
},
"vulnerability_info": {
"verdict": 0
},
"yara_info": {},
"extracted_files": [
{
"data_id": "3b503f416a1d40ffacf79a8141baa1e7",
"dlp_info": {},
"file_info": {
"display_name": "test.zip",
"file_size": 168,
"file_type": "application/zip",
"file_type_description": "ZIP Archive",
"md5": "9a061b387f4d94babe13be5aa7c80077",
"sha1": "b70a3bcaa67217b410211a8e6511c8f14b571ce1",
"sha256": "1af488779d0fabf4b4bc7d920627d85c7256b4241bfda486cec6ba278eea1192",
"upload_timestamp": "2019-03-25T07:48:25.013Z"
},
"process_info": {
"blocked_reason": "",
"file_type_skipped_scan": false,
"post_processing": {
"actions_failed": "",
"actions_ran": "",
"converted_destination": "",
"converted_to": "",
"copy_move_destination": ""
},
"processing_time": 69,
"profile": "File process",
"progress_percentage": 100,
"queue_time": 5,
"result": "Allowed",
"user_agent": "webscan",
"username: "LOCAL/admin",
"verdicts": [
"No Threat Detected"
]
},
"scan_results": {
"data_id": "3b503f416a1d40ffacf79a8141baa1e7",
"progress_percentage": 100,
"scan_all_result_a": "No Threat Detected",
"scan_all_result_i": 0,
"scan_details": {
"ClamAV": {
"def_time": "2019-03-24T08:46:29.000Z",
"eng_id": "clamav_1_linux",
"location": "local",
"scan_result_i": 0,
"scan_time": 3,
"threat_found": "",
"wait_time": 2
}
},
"start_time": "2019-03-25T07:48:25.018Z",
"total_avs": 1,
"total_time": 55
},
"vulnerability_info": {
"verdict": 0
},
"yara_info": {},
"extracted_files": [
{
"data_id": "1014ec91e0b246489fa357ce1d02f8b1",
"dlp_info": {},
"file_info": {
"display_name": "test.txt",
"file_size": 2,
"file_type": "text/plain",
"file_type_description": "ASCII text",
"md5": "60b725f10c9c85c70d97880dfe8191b3",
"sha1": "3f786850e387550fdab836ed7e6dc881de23001b",
"sha256": "87428fc522803d31065e7bce3cf03fe475096631e5e07bbd7a0fde60c4cf25c7",
"upload_timestamp": "2019-03-25T07:48:25.025Z"
},
"process_info": {
"blocked_reason": "",
"file_type_skipped_scan": false,
"post_processing": {
"actions_failed": "",
"actions_ran": "",
"converted_destination": "",
"converted_to": "",
"copy_move_destination": ""
},
"processing_time": 47,
"profile": "File process",
"progress_percentage": 100,
"queue_time": 4,
"result": "Allowed",
"user_agent": "webscan",
"username: "LOCAL/admin",
"verdicts": [
"No Threat Detected"
]
},
"scan_results": {
"data_id": "1014ec91e0b246489fa357ce1d02f8b1",
"progress_percentage": 100,
"scan_all_result_a": "No Threat Detected",
"scan_all_result_i": 0,
"scan_details": {
"ClamAV": {
"def_time": "2019-03-24T08:46:29.000Z",
"eng_id": "clamav_1_linux",
"location": "local",
"scan_result_i": 0,
"scan_time": 0,
"threat_found": "",
"wait_time": 4
}
},
"start_time": "2019-03-25T07:48:25.029Z",
"total_avs": 1,
"total_time": 35
},
"vulnerability_info": {
"verdict": 0
},
"yara_info": {}
}
]
},
{
"data_id": "a80f3b43192843f28998abcfe073c3be",
"dlp_info": {},
"file_info": {
"display_name": "test.txt",
"file_size": 2,
"file_type": "text/plain",
"file_type_description": "ASCII text",
"md5": "60b725f10c9c85c70d97880dfe8191b3",
"sha1": "3f786850e387550fdab836ed7e6dc881de23001b",
"sha256": "87428fc522803d31065e7bce3cf03fe475096631e5e07bbd7a0fde60c4cf25c7",
"upload_timestamp": "2019-03-25T07:48:25.012Z"
},
"process_info": {
"blocked_reason": "",
"file_type_skipped_scan": false,
"post_processing": {
"actions_failed": "",
"actions_ran": "",
"converted_destination": "",
"converted_to": "",
"copy_move_destination": ""
},
"processing_time": 33,
"profile": "File process",
"progress_percentage": 100,
"queue_time": 3,
"result": "Allowed",
"user_agent": "webscan",
"username": "LOCAL/admin",
"verdicts": [
"No Threat Detected"
]
},
"scan_results": {
"data_id": "a80f3b43192843f28998abcfe073c3be",
"progress_percentage": 100,
"scan_all_result_a": "No Threat Detected",
"scan_all_result_i": 0,
"scan_details": {
"ClamAV": {
"def_time": "2019-03-24T08:46:29.000Z",
"eng_id": "clamav_1_linux",
"location": "local",
"scan_result_i": 0,
"scan_time": 0,
"threat_found": "",
"wait_time": 1
}
},
"start_time": "2019-03-25T07:48:25.015Z",
"total_avs": 1,
"total_time": 23
},
"vulnerability_info": {
"verdict": 0
},
"yara_info": {}
}
]
}

Using this method the following fields will not be shown compared to /file request containing extracted files

  • files_extracted_count

  • files_in_archive

  • first_index

  • page_size

  • worst_data_id

Also the "outdated_data" field will only be shown in the root archive.

Response (not existing data_id)

HTTP status code: 200

{
"61dffeaa728844adbf49eb090e4ece0e": "Not Found"
}

Response (requested file is not an archive)

HTTP status code: 200

{
"61dffeaa728844adbf49eb090e4ece0e": "Invalid request"
}

Error response

Unexpected event on server

HTTP status code: 500

{
"err": "<error message>"
}