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

Auto Complete Search

Description

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

Request

URL

URL


post
https://api.example.com/napp/api/v1/malware-prevention/auto-complete/search
Copy

Query Parameters

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

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


boolean
sort_ascending Optional

Sort records by ascending order.


string
sort_by Optional

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

Possible values are: MALWARE_CLASSMALWARE_FAMILYFILE_TYPE


Request Body

Request Body

AutoCompleteRequest of type(s) application/json Required

Auto-Complete Request

{
	"case_sensitive": false,
	"field_name": "MALWARE_CLASS",
	"value": "string"
}
boolean
case_sensitive Optional

Conveys if the value is case-sensitive or not.


string
field_name Optional

Field to be filtered on.

Possible values are: MALWARE_CLASSMALWARE_FAMILYFILE_TYPE


string
value Optional

Filter value.

Authentication

Authentication

This operation uses the following authentication methods.


METHOD

security_op


METHOD

auditor


Response

Response

Response Body

Response Body

200 OK

Returns AutoCompleteResponse of type(s) application/json
This response body class contains all of the following: ListResult, InlineAutoCompleteResponse1

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"case_sensitive":false,"field_name":"MALWARE_CLASS","value":"string"}' https://api.example.com/napp/api/v1/malware-prevention/auto-complete/search


Feedback

Was this page helpful?