v1

latestOpenAPI 3.0.02026-07-14161138164.1 KB
Search

Search entities

Using search API you can search vRealize Network Insight entities by specifying entity type and filter expression. A filter expression is a predicate expression (similar to SQL where clause) used to define the search criteria. Please refer to API Guide on details of how to construct filter expression. A successful search request will return a list of entity ids that matches the search criteria.

post/search

Request body

cursorstring
entity_type'Group' | 'BaseSecurityGroup' | 'BaseEvent' | 'BaseVirtualMachine' | 'BaseFirewallRule' | 'BaseIPSet' | 'BaseL2Network' | 'BaseFirewall' | 'BaseService' | 'BaseServiceGroup' | 'BaseVnic' | 'VirtualMachine' | 'EC2Instance' | 'Host' | 'Vnic' | 'Vmknic' | 'VxlanLayer2Network' | 'VlanL2Network' | 'Cluster' | 'SecurityTag' | 'ResourcePool' | 'NSXIPSet' | 'EC2IPSet' | 'NSXSecurityGroup' | 'EC2SecurityGroup' | 'Flow' | 'ProblemEvent' | 'Application' | 'Tier' | 'NSXFirewallRule' | 'EC2SGFirewallRule' | 'NSXRedirectRule' | 'VCenterManager' | 'NSXVManager' | 'BaseManager' | 'BaseNSXManager' | 'NSXService' | 'EC2Service' | 'VPC' | 'NSXDistributedFirewall' | 'EC2Firewall' | 'NSXServiceGroup' | 'DistributedVirtualSwitch' | 'DistributedVirtualPortgroup' | 'VCDatacenter' | 'Datastore' | 'Folder'
filterstring

query filter

sizeinteger

Response

Success

cursorstring
end_timeinteger
start_timeinteger
total_countinteger

Example response

{
  "cursor": "ML12eu02==",
  "end_time": 1504739809,
  "start_time": 1504739809,
  "total_count": 100
}