Get Inspected Files

Get Inspected Files

Get list of inspected files. This API will return maximum 10,000 unique inspected files for any specified time window of start_time and end_time. Pagination is supported in the specified time window upto 10,000 inspected files. If page_size and cursor combination passed is referring to more than 10,000 inspected files, this API will throw an error. And this API will return only basic information about the inspected files. Please use /inspected-files/details API for getting full details of an inspected file and corresponding number of workloads_affected count, once the file hash is known from this API response.

Request
URI
GET
https://api.example.com/napp/api/v1/malware-prevention/inspected-files
COPY
Query Parameters
integer
start_time
Required

Use this request param for specifiying starting time of a timeline. Value has to be specified in milliseconds since epoch.

integer
end_time
Required

Use this request param for specifiying ending time of a timeline. Value has to be specified in milliseconds since epoch.

string of array
sha256
Optional

Use this request param for specifying sha256 hash to filter. If this parameter is passed multiple times, OR condition will be assumed.

string of array
sha1
Optional

Use this request param for specifying sha1 hash to filter. If this parameter is passed multiple times, OR condition will be assumed.

string of array
md5
Optional

Use this request param for specifying md5 hash to filter. If this parameter is passed multiple times, OR condition will be assumed.

string of array
verdict
Optional

Use this request param for specifying verdict to filter. If this parameter is passed multiple times, OR condition will be assumed.

boolean
allow_listed
Optional

Used for specifying filter of allow listed files. By default, this parameter will be considered null and no filtering on allow_listed value will be applied.

string of array
malware_family
Optional

Used for specifying malware family to filter. If this parameter is passed multiple times, OR condition will be assumed.

string of array
malware_class
Optional

Used for specifying malware class to filter. If this parameter is passed multiple times, OR condition will be assumed.

boolean
is_blocked
Optional

Used for specifying filter of blocked files. By default, this parameter will be considered null and no filtering on is_blocked value will be applied.

string of array
file_type
Optional

Used for specifying file_type to filter. If this parameter is passed multiple times, OR condition will be assumed.

string
sort_by
Optional

Field by which records are sorted. If THREAT_SCORE is selected, then records are first sorted by LAST_INSPECTED_TIME to filter last 10,000 unique files inspected and then result set is sorted by THREAT_SCORE.

Possible values are : LAST_INSPECTED_TIME, THREAT_SCORE,
boolean
sort_ascending
Optional

If records need to be sorted in ascending order.

string
cursor
Optional

Opaque cursor to be used for getting next page of records (supplied by current result page).

integer
page_size
Optional

Maximum number of results to return in this page (server may return fewer).


Authentication
This operation uses the following authentication methods.
Responses
200

Successful Operation

Returns InspectedFilesListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineInspectedFilesListResult1
{
    "_self": {},
    "_links": [
        {
            "href": "string",
            "action": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "result_count": 0,
    "sort_by": "string",
    "sort_ascending": false,
    "cursor": "string",
    "results": [
        {
            "sha256": "string",
            "sha1": "string",
            "md5": "string",
            "file_size": 0,
            "last_inspected": 0,
            "inspection_status": "string",
            "threat_score": 0,
            "verdict": "string",
            "error_message": "string",
            "error_code": "string",
            "allow_listed": {
                "last_inspection_setting": false,
                "current_setting": false
            },
            "malware_family": [
                "string"
            ],
            "malware_class": [
                "string"
            ],
            "is_blocked": false,
            "file_type": "string",
            "inspections_count": 0
        }
    ]
}