[{"label":"Latest (1.0.0)","version":"latest"}]
nsx-malware-prevention

Get Inspected Files

Description

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

Request

URL

URL


get
https://api.example.com/napp/api/v1/malware-prevention/inspected-files
Copy

Query Parameters

Query Parameters

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
cursor Optional

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


integer
end_time Required

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


array
file_type Optional

Used for specifying file_type 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.


array
malware_class Optional

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


array
malware_family Optional

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


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.


integer
page_size Optional

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


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.


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.


boolean
sort_ascending Optional

If records need to be sorted in ascending order.


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_TIMETHREAT_SCORE


integer
start_time Required

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


array
verdict Optional

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


Authentication

Authentication

This operation uses the following authentication methods.


METHOD

security_op


METHOD

auditor


Response

Response

Response Body

Response Body

200 OK

Returns InspectedFilesListResult of type(s) application/json

Successful Operation

This response body class contains all of the following: ListResult, InlineInspectedFilesListResult1

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://api.example.com/napp/api/v1/malware-prevention/inspected-files?end_time=10&start_time=10


Feedback

Was this page helpful?