Auto Complete Search

This API will provide auto-complete functionality for the filters provided on Potential Malware screen. This API will return the records matching the pattern string entered for the specific filter. If the user does not enter any value, then this API will return all unique records. This API will return maximum 10,000 unique records for any specified filter. Pagination is supported in the window upto 10,000 records.

Request

URI

POST

https://{api_host}/napp/api/v1/malware-prevention/auto-complete/search

COPY

Query Parameters

string

cursor

Optional

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

integer

page_size

Optional

Constraints: minimum: 1 maximum: 10000 default: 10000

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

boolean

sort_ascending

Optional

Constraints: default: true

Sort records by ascending order.

string

sort_by

Optional

Constraints: default: MALWARE_CLASS

Conveys the key on which we want to provide the auto-complete functionality.

Possible values are : MALWARE_CLASS, MALWARE_FAMILY, FILE_TYPE,

string of array

site_id

Optional

ID of the NSX+ site which reported this file event. If the parameter is not passed, corresponding API will respond with results across all sites managed within NSX+ instance. This parameter will support single value. If value passed is empty string, it will be considered as valid input for filtering. This parameter is supported only in NSX+.

Request Body

Auto-Complete Request

AutoCompleteRequest of type(s) application/json

Required

"AutoCompleteRequest Object"

string

field_name

Optional

Field to be filtered on.

Possible values are : MALWARE_CLASS, MALWARE_FAMILY, FILE_TYPE,

string

value

Optional

Filter value.

boolean

case_sensitive

Optional

Conveys if the value is case-sensitive or not.

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

security_op

auditor

Responses

200

Returns AutoCompleteResponse of type(s) application/json

This response body class contains all of the following: InlineAutoCompleteResponse1

"AutoCompleteResponse Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/napp/api/v1/malware-prevention/auto-complete/search

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Malware Prevention Operations

GET

Get File Inspection Events

GET