Get the list of the VMs affected for that signature

Get the list of the VMs affected pertaining to a specific
signature.

Request:

Method:

POST

URI Path(s):

/api/v1/intrusion-services/affected-vms

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

IDSEventDataRequest+

Name	Description	Type	Notes
filters	Filter conditions An array of filter conditions.	array of FilterRequest

Example Request:

POST https://<nsx-mgr>/api/v1/intrusion-services/affected-vms { "filters": [ { "field_names": "signature_detail.severity", "value": "(CRITICAL OR MEDIUM OR LOW OR MAJOR)" }, { "field_names": "signature_detail.signature_id", "value": "(4010643)" } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IdsVmList+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of all affected VMs List of all affected VMs specific to a particular signature.	array of string	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [ "1-vm_ubuntu-18.04-server-amd64-local-1702-38876fd9-5748-4cdc-93f7-3c45791622b7", "1-linuxrouter_ubuntu-16.04-server-amd64-container-local-1702-d3fadb32-c51e-437a-86f1-ff717c6d736f" ], "result_count": 2, "sort_by": "displayName", "sort_ascending": false, "cursor": "2" }

Get the list of the VMs affected for that signature

Request:

ListRequestParameters (schema)

IDSEventDataRequest (schema)

Example Request:

Successful Response:

IdsVmList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: