vRealize Network Insight API Reference
vRealize Network Insight API Reference
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
vRealize Network Insight API Reference
Endpoints 161
Authentication
- POSTCreate an auth token
/auth/token<html><body> vRealize Network Insight supports token based authentication.Tokens are non-modifiable identifiers returned by the system when the user has… - DELETEDelete an auth token.
/auth/tokenDeletes the auth token provided in Authorization header. Deleting an expired or invalid token will result in 401 Unauthorized error.
Data Sources
- GETList arista switch data sources
/data-sources/arista-switchesList arista switch data sources - POSTCreate an arista switch data source
/data-sources/arista-switchesAdd arista switch data source - GETShow arista switch data source details
/data-sources/arista-switches/:idShow arista switch data source details - PUTUpdate an arista switch data source
/data-sources/arista-switches/:idUpdate an switch data source - DELETEDelete an arista switch data source
/data-sources/arista-switches/:idDelete an arista switch data source - POSTDisable an arista switch data source
/data-sources/arista-switches/:id/disableDisable an arista switch data source - POSTEnable an arista switch data source
/data-sources/arista-switches/:id/enableEnable an arista switch data source - GETShow snmp config for arista switch data source
/data-sources/arista-switches/:id/snmp-configShow snmp config for arista switch data source - PUTUpdate snmp config for arista switch data source
/data-sources/arista-switches/:id/snmp-configUpdate snmp config for arista switch data source - GETList brocade switch data sources
/data-sources/brocade-switchesList brocade switch data sources - POSTCreate a brocade switch data source
/data-sources/brocade-switchesAdd brocade switch as a data source - GETShow brocade switch data source details
/data-sources/brocade-switches/:idShow brocade switch data source details - PUTUpdate a brocade switch data source
/data-sources/brocade-switches/:idUpdate a brocade switch data source. Only credentials, nickname and notes can be updated. - DELETEDelete a brocade switch data source
/data-sources/brocade-switches/:idDelete a brocade switch data source - POSTDisable a brocade switch data source
/data-sources/brocade-switches/:id/disable - POSTEnable a brocade switch data source
/data-sources/brocade-switches/:id/enable - GETShow snmp config for brocade switch data source
/data-sources/brocade-switches/:id/snmp-configShow snmp config for brocade switch data source - PUTUpdate snmp config for brocade switch data source
/data-sources/brocade-switches/:id/snmp-configUpdate snmp config for brocade switch data source - GETList checkpoint firewall data sources
/data-sources/checkpoint-firewallsList checkpoint firewall data sources - POSTCreate a checkpoint firewall
/data-sources/checkpoint-firewallsAdd checkpoint firewall as data source - GETShow checkpoint firewall data source details
/data-sources/checkpoint-firewalls/:idShow checkpoint firewall data source details - PUTUpdate a checkpoint firewall data source
/data-sources/checkpoint-firewalls/:idUpdate a checkpoint firewall data source - DELETEDelete a checkpoint firewall data source
/data-sources/checkpoint-firewalls/:idDelete a checkpoint firewall data source - POSTDisable a checkpoint firewall data source
/data-sources/checkpoint-firewalls/:id/disableDisable a checkpoint firewall data source - POSTEnable a checkpoint firewall data source
/data-sources/checkpoint-firewalls/:id/enableEnable a checkpoint firewall data source - GETList cisco switch data sources
/data-sources/cisco-switchesList cisco switch data sources - POSTCreate a cisco switch data source
/data-sources/cisco-switchesAdd cisco switch as data source. User must provide one of ip or fqdn field in the request body. Appropriate proxy id is retrieved from infra/nodes URL to… - GETShow cisco switch data source details
/data-sources/cisco-switches/:idShow cisco switch data source details - PUTUpdate a cisco switch data source
/data-sources/cisco-switches/:idUpdate a cisco switch data source. Only credentials, nickname and notes can be updated. - DELETEDelete a cisco switch data source
/data-sources/cisco-switches/:idDelete a cisco switch data source - POSTDisable a cisco switch data source
/data-sources/cisco-switches/:id/disableDisable a cisco switch data source - POSTEnable a cisco switch data source
/data-sources/cisco-switches/:id/enableEnable a cisco switch data source - GETShow snmp config for cisco switch data source
/data-sources/cisco-switches/:id/snmp-configShow snmp config for cisco switch data source - PUTUpdate snmp config for cisco switch data source
/data-sources/cisco-switches/:id/snmp-configUpdate snmp config for cisco switch data source - GETList dell switch data sources
/data-sources/dell-switchesList dell switch data sources - POSTCreate a dell switch data source
/data-sources/dell-switchesAdd a dell switch as data source - GETShow dell switch data source details
/data-sources/dell-switches/:idGet a dell switch data source details - PUTUpdate a dell switch data source
/data-sources/dell-switches/:idUpdate a dell switch data source. Only credentials, nickname and notes can be updated - DELETEDelete a dell switch data source
/data-sources/dell-switches/:idDelete a data source - POSTDisable a dell switch data source
/data-sources/dell-switches/:id/disableDisable a dell switch data source - POSTEnable a dell switch data source
/data-sources/dell-switches/:id/enableEnable a dell switch data source - GETShow snmp config for dell switch data source
/data-sources/dell-switches/:id/snmp-configShow snmp config for dell switch data source - PUTUpdate snmp config for dell switch data source
/data-sources/dell-switches/:id/snmp-configUpdate snmp config for dell switch data source - GETList hp oneview manager data sources
/data-sources/hpov-managersList hp oneview manager data sources - POSTCreate a hp oneview manager data source
/data-sources/hpov-managersAdd a hp oneview manager data source - GETShow hp oneview data source details
/data-sources/hpov-managers/:idShow hp oneview data source details - PUTUpdate a hp oneview data source
/data-sources/hpov-managers/:idUpdate a hp oneview data source - DELETEDelete a hp oneview data source
/data-sources/hpov-managers/:idDelete a hp oneview data source - POSTDisable a hp oneview data source
/data-sources/hpov-managers/:id/disableDisable a hp oneview data source - POSTEnable a hp oneview data source
/data-sources/hpov-managers/:id/enableEnable a hp oneview data source - GETList hpvc manager data sources
/data-sources/hpvc-managersList hpvc manager data sources - POSTCreate a hpvc manager data source
/data-sources/hpvc-managersAdd hpvc manager data source - GETShow hpvc data source details
/data-sources/hpvc-managers/:idShow hpvc data source details - PUTUpdate a hpvc manager data source
/data-sources/hpvc-managers/:idUpdate a hpvc manager data source - DELETEDelete a hpvc manager data source
/data-sources/hpvc-managers/:idDelete a hpvc manager data source - POSTDisable a hpvc manager data source
/data-sources/hpvc-managers/:id/disableDisable a hpvc manager data source - POSTEnable a hpvc manager data source
/data-sources/hpvc-managers/:id/enableEnable a hpvc manager data source - GETList juniper switch data sources
/data-sources/juniper-switchesList juniper switch data sources - POSTAdd a juniper switch as data source
/data-sources/juniper-switchesAdd switch Datasource - GETShow juniper switch data source details
/data-sources/juniper-switches/:idShow juniper switch data source details - PUTUpdate a juniper switch data source
/data-sources/juniper-switches/:idUpdate a juniper switch data source - DELETEDelete a juniper switch data source
/data-sources/juniper-switches/:idDelete a juniper switch data source - POSTDisable a juniper switch data source
/data-sources/juniper-switches/:id/disableDisable a juniper switch data source - POSTEnable a juniper switch data source
/data-sources/juniper-switches/:id/enableEnable a juniper switch data source - GETShow snmp config for juniper switch data source
/data-sources/juniper-switches/:id/snmp-configShow snmp config for juniper switch data source - PUTUpdate snmp config for a juniper switch data source
/data-sources/juniper-switches/:id/snmp-configUpdate snmp config for a juniper switch data source - GETList nsx-v manager data sources
/data-sources/nsxv-managersList nsx-v manager data sources - POSTCreate a nsx-v manager data source
/data-sources/nsxv-managersAdd a nsx-v manager data source - GETShow nsx-v manager data source details
/data-sources/nsxv-managers/:idShow nsx-v manager data source details - PUTUpdate a nsx-v manager data source
/data-sources/nsxv-managers/:idUpdate a nsx-v manager data source - DELETEDelete a nsx-v manager data source
/data-sources/nsxv-managers/:idDelete a nsx-v manager data source - GETShow nsx controller-cluster details
/data-sources/nsxv-managers/:id/controller-clusterShow nsx controller-cluster details - PUTUpdate nsx controller-cluster details
/data-sources/nsxv-managers/:id/controller-clusterUpdate nsx controller-cluster details - POSTDisable a nsx-v manager data source
/data-sources/nsxv-managers/:id/disableDisable a nsx-v manager data source - POSTEnable a nsx-v manager data source
/data-sources/nsxv-managers/:id/enableEnable a nsx-v manager data source - GETList panorama firewall data sources
/data-sources/panorama-firewallsList panorama firewall data sources - POSTCreate panorama firewall data source
/data-sources/panorama-firewallsAdd panorama firewall as data source - GETShow panorama firewall data source details
/data-sources/panorama-firewalls/:idShow panorama firewall data source details - PUTUpdate a panorama firewall data source
/data-sources/panorama-firewalls/:idUpdate a panorama firewall data source - DELETEDelete a panorama firewall data source
/data-sources/panorama-firewalls/:idDelete a panorama firewall data source - POSTDisable a panorama firewall data source
/data-sources/panorama-firewalls/:id/disableDisable a panorama firewall data source - POSTEnable a panorama firewall data source
/data-sources/panorama-firewalls/:id/enableEnable a panorama firewall data source - GETList ucs manager data sources
/data-sources/ucs-managersList ucs manager data sources - POSTCreate an ucs manager data source
/data-sources/ucs-managersAdd an ucs manager as data source - GETShow ucs manager data source details
/data-sources/ucs-managers/:idShow ucs manager data source details - PUTUpdate an ucs manager data source
/data-sources/ucs-managers/:idUpdate an ucs manager data source - DELETEDelete an ucs manager data source
/data-sources/ucs-managers/:idDelete an ucs manager data source - POSTDisable an ucs manager data source
/data-sources/ucs-managers/:id/disableDisable an ucs manager data source - POSTEnable an ucs manager data source
/data-sources/ucs-managers/:id/enableEnable an ucs manager data source - GETShow snmp config for ucs fabric interconnects
/data-sources/ucs-managers/:id/snmp-configShow snmp config for ucs fabric interconnects - PUTUpdate snmp config for ucs fabric interconnects
/data-sources/ucs-managers/:id/snmp-configUpdate snmp config for ucs fabric interconnects - GETList vCenter data sources
/data-sources/vcentersList vCenter data sources - POSTCreate a vCenter data source
/data-sources/vcentersAdd a vcenter data source. User must provide one of ip or fqdn field in the request body. Appropriate proxy id is retrieved from infra/nodes URL to select the… - GETShow vCenter data source details
/data-sources/vcenters/:idShow vCenter data source details - PUTUpdate a vCenter data source.
/data-sources/vcenters/:idUpdate a vcenter data source. Only nickname, notes and credentials can be updated. - DELETEDelete a vCenter data source
/data-sources/vcenters/:idDelete a data source - POSTDisable a vCenter data source
/data-sources/vcenters/:id/disableDisable a vCenter data source - POSTEnable a vCenter data source
/data-sources/vcenters/:id/enableEnable a vCenter data source
Entities
- GETList clusters
/entities/clusters?size=10&cursor=string&start_time=0.0&end_time=0.0List clusters - GETShow cluster details
/entities/clusters/:id?time=0Show cluster details - GETList datastores
/entities/datastores?size=10&cursor=string&start_time=0.0&end_time=0.0List datastores - GETShow datastore details
/entities/datastores/:id?time=0Show datastore details - GETList distributed virtual portgroups
/entities/distributed-virtual-portgroups?size=10&cursor=string&start_time=0.0&end_time=0.0List distributed virtual portgroups - GETShow distributed virtual portgroup details
/entities/distributed-virtual-portgroups/:id?time=0Show distributed virtual portgroup details - GETList distributed virtual switches
/entities/distributed-virtual-switches?size=10&cursor=string&start_time=0.0&end_time=0.0List distributed virtual switches - GETShow distributed virtual switch details
/entities/distributed-virtual-switches/:id?time=0Show distributed virtual switch details - GETList firewall rules
/entities/firewall-rules?size=10&cursor=string&start_time=0.0&end_time=0.0List firewall rules - GETShow firewall rule details
/entities/firewall-rules/:id?time=0Show firewall rule details - GETList firewalls
/entities/firewalls?size=10&cursor=string&start_time=0.0&end_time=0.0List firewalls - GETShow firewall details
/entities/firewalls/:id?time=0Show firewall details - GETList flows
/entities/flows?size=10&cursor=string&start_time=0.0&end_time=0.0List flows - GETShow flow details
/entities/flows/:id?time=0Show flow details - GETList folders
/entities/folders?size=10&cursor=string&start_time=0.0&end_time=0.0List folders - GETShow folder details
/entities/folders/:id?time=0Show folder details - GETList hosts
/entities/hosts?size=10&cursor=string&start_time=0.0&end_time=0.0List hosts - GETShow host details
/entities/hosts/:id?time=0Show host details - GETList ip sets
/entities/ip-sets?size=10&cursor=string&start_time=0.0&end_time=0.0List ip sets - GETShow ip set details
/entities/ip-sets/:id?time=0Show ip set details - GETList layer2 networks
/entities/layer2-networks?size=10&cursor=string&start_time=0.0&end_time=0.0List layer2 networks - GETShow layer2 network details
/entities/layer2-networks/:id?time=0Show layer2 network details - POSTGet names for entities
/entities/namesGet names for entities.Limit of 1000 entities in a single request. - GETGet name of an entity
/entities/names/:id?time=0Get name of an entity - GETList nsx managers
/entities/nsx-managers?size=10&cursor=string&start_time=0.0&end_time=0.0List nsx managers - GETShow nsx manager details
/entities/nsx-managers/:id?time=0Show nsx manager details - GETList problems
/entities/problems?size=10&cursor=string&start_time=0.0&end_time=0.0List problem events. - GETShow problem details
/entities/problems/:id?time=0Show problem event details. - GETList security groups
/entities/security-groups?size=10&cursor=string&start_time=0.0&end_time=0.0List security groups - GETShow security group details
/entities/security-groups/:id?time=0Show security group details - GETList security tags
/entities/security-tags?size=10&cursor=string&start_time=0.0&end_time=0.0List security tags - GETShow security tag details
/entities/security-tags/:id?time=0Show security tag details - GETList service groups
/entities/service-groups?size=10&cursor=string&start_time=0.0&end_time=0.0List service groups - GETShow service group details
/entities/service-groups/:id?time=0Show service group details - GETList services
/entities/services?size=10&cursor=string&start_time=0.0&end_time=0.0List services - GETShow service details
/entities/services/:id?time=0Show service details - GETList vCenter datacenters
/entities/vc-datacenters?size=10&cursor=string&start_time=0.0&end_time=0.0List vCenter datacenters - GETShow vCenter datacenter details
/entities/vc-datacenters/:id?time=0Show vCenter datacenter details - GETList vCenter managers
/entities/vcenter-managers?size=10&cursor=string&start_time=0.0&end_time=0.0List vCenter managers - GETShow vCenter manager details
/entities/vcenter-managers/:id?time=0Show vCenter manager details - GETList vmknics
/entities/vmknics?size=10&cursor=string&start_time=0.0&end_time=0.0List vmknics - GETShow vmknic details
/entities/vmknics/:id?time=0Show vmknic details - GETList vms
/entities/vms?size=10&cursor=string&start_time=0.0&end_time=0.0List vms - GETShow vm details
/entities/vms/:id?time=0Show vm details - GETList vnics
/entities/vnics?size=10&cursor=string&start_time=0.0&end_time=0.0List vnics - GETShow vnic details
/entities/vnics/:id?time=0Show vnic details
Search
- POSTSearch entities
/searchUsing search API you can search vRealize Network Insight entities by specifying entity type and filter expression. A filter expression is a predicate…
Infrastructure
- GETList nodes
/infra/nodesGet list of infrastructure nodes. Only admin users can retrieve this information. - GETShow node details
/infra/nodes/:idGet details of infrastructure nodes. Only admin users can get this information. The proxy id is required for adding a data source for selecting appropriate…
Applications
- GETList applications
/groups/applications?size=10&cursor=string&start_time=0.0&end_time=0.0List applications - POSTCreate an application
/groups/applicationsApplication is a group of tiers. A tier is a group of virtual machines based on membership criteria. Tiers are bound to single application. An application… - GETShow application details
/groups/applications/:idShow application details - DELETEDelete an application
/groups/applications/:idDeleting an application deletes all the tiers of the application along with the application - GETList tiers of an application
/groups/applications/:id/tiersList tiers of an application - POSTCreate tier in application
/groups/applications/:id/tiersCreate a tier of an application by with specified membership criteria. The membership criteria id defined in terms of virtual machines or ip addresses/subnet.… - GETShow tier details
/groups/applications/:id/tiers/:tier-idShow tier details - DELETEDelete tier
/groups/applications/:id/tiers/:tier-idDelete tier of an application - GETShow tier details
/groups/tiers/:tier-idShow tier details
Microsegmentation
- POSTGet logical recommended rules
/micro-seg/recommended-rulesGet recommended firewall rules based on the flow data gathered by vRealize Network Insight. This API provides service to retrieve recommended rules based on… - POSTExport recommended rules for NSX-V
/micro-seg/recommended-rules/nsxExport recommended firewall rules based on the flow data gathered by vRealize Network Insight in NSX-V compatible format
Info
- GETShow version info
/info/versionShow version info
API details
- Base URL
http://vmware.localhttps://vrni.example.com/api/ni- Authentication
- An API key in the Authorization header
- Operations
- 161 operations on 113 pathsGET 84POST 43PUT 19DELETE 15
- Main resources
- Data Sources 98Entities 46Applications 9Authentication 2Infrastructure 2Microsegmentation 2Info 1Search 1
- Response formats
application/jsoncursorend_timeentity_id- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the vRealize Network Insight API Reference in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the vRealize Network Insight API Reference collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create an auth token” (POST /auth/token), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the vRealize Network Insight API Reference?
vRealize Network Insight API Reference It is listed under Developer tools and has 161 endpoints.
Who publishes the vRealize Network Insight API Reference?
It is listed from VMware's public API description (an OpenAPI document), not published by VMware on Swastik Codes. Anyone who controls vmware.com can claim the profile by adding a DNS TXT record.
What is the base URL of the vRealize Network Insight API Reference?
Its description lists 2 base URLs: http://vmware.local, https://vrni.example.com/api/ni. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the vRealize Network Insight API Reference?
With an API key in the Authorization header.
How many endpoints does the vRealize Network Insight API Reference have?
161 operations on 113 paths (84 GET, 43 POST, 19 PUT, 15 DELETE). The largest groups are Data Sources, Entities, Applications, Authentication.
Is forking the vRealize Network Insight API Reference free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.