[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Search Entities

Description

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.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/search
Copy

Request Body

Request Body

SearchRequest of type(s) application/json Optional

Search Request

{
	"cursor": "string",
	"entity_type": "Group",
	"filter": "string",
	"size": 0,
	"sort_by": {
		"field": "string",
		"order": "ASC"
	},
	"time_range": {
		"end_time": 1597247999,
		"start_time": 1597247025
	}
}
string
cursor Optional

entity_type Optional

Possible values are: GroupBaseSecurityGroupBaseEventBaseVirtualMachineBaseFirewallRuleBaseFirewallSectionBaseIPSetBaseL2NetworkBaseFirewallBaseServiceBaseServiceGroupBaseVnicVirtualMachineEC2InstanceHostVnicVmknicVxlanLayer2NetworkVlanL2NetworkClusterSecurityTagResourcePoolNSXIPSetNSXTIPSetEC2IPSetNSXSecurityGroupNSGroupNSXPolicyGroupEC2SecurityGroupFlowProblemEventApplicationTierIPEndpointNSXFirewallRuleEC2SGFirewallRuleNSXRedirectRuleVCenterManagerNSXVManagerNSXTManagerNSXPolicyManagerCheckpointManagerCheckpointMDSManagerBaseManagerBaseFirewallManagerBaseNSXManagerNSXServiceEC2ServiceNSServiceVPCCloudNetworkAzureVMAzureNSGAzureASGAzureNSGRuleNSXDistributedFirewallEC2FirewallNSXServiceGroupNSServiceGroupDistributedVirtualSwitchDistributedVirtualPortgroupVCDatacenterDatastoreFolderNSXTFirewallRuleNSXTFirewallPolicyManagerFirewallRulePolicyManagerFirewallBaseGenericFirewallBaseGenericFirewallRuleCheckpointFirewallCheckpointFirewallRuleUserDefinedSubnetKubernetesServiceUserDefinedProblemEventFirewallRuleMaskEventEdgeDeviceRouterDeviceNSXControllerLogicalRouterNSXTManagementNodeNSXTControllerNSXTTransportNodeNSXTTransportZoneNSXTLoadBalancerNSXTVirtualServerNSXTServerPoolNSXTLogicalSwitchNSXTRouterDeviceNSXTEdgeClusterNSXControllerClusterAzureSubscriptionAWSAccountManagerHcxDataSourceVMCSDDCVMCCapacityThresholdBreachEventPolicyManagerSegmentPolicyManagerFirewallSectionDirectConnectInterface


string
filter Optional

query filter


integer as int32
size Optional

sort_by Optional

time_range Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PagedListResponseWithTime of type(s) application/json
{
	"cursor": "ML12eu02==",
	"end_time": 1504739809,
	"results": [
		{
			"entity_id": "string",
			"entity_type": "VirtualMachine",
			"time": 0
		}
	],
	"start_time": 1504739809,
	"total_count": 100
}
string
cursor Optional

Cursor for the next page


integer as int64
end_time Optional

End timestamp of the window of the objects returned


array of EntityIdWithTime
results Optional

integer as int64
start_time Optional

Start timestamp of the window of the objects returned


integer
total_count Optional

Total number of objects returned

Errors

Errors

400

Bad Request


401

Unauthorized


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"cursor":"string","entity_type":"Group","filter":"string","size":0,"sort_by":{"field":"string","order":"ASC"},"time_range":{"end_time":1597247999,"start_time":1597247025}}' https://vrni.example.com/api/ni/search


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Feedback

Was this page helpful?