VMware Cloud Foundation Operations for Networks API Reference Operations Index

VMware Cloud Foundation Operations for Networks API Reference Operations Index

All available VMware Cloud Foundation Operations for Networks API Reference Operations

Applications
GET
List Applications

List applications in VCF Operations for Networks
POST
Add Application

Application is a group of tiers. A tier is a group of virtual machines or IP addresses based on membership criteria. Tiers are bound to a single application. An application name is unique and should not conflict with another application name.
GET
Get Application By Id

Get application summary for an entity ID. This returns the application name.
DELETE
Delete Application

Deleting an application deletes all the tiers of the application along with the application
GET
Get Bulk Application Task Progress

GET progress of bulk application creation request
POST
Save Discovered Applications

Save multiple discovered applications of particular discovery source.
GET
Get App Problems

List Application problem events.
GET
Get Application Vms

Show application members
POST
Get Applications Members

Get member details of applications
POST
Get Tiers Members

Get member details of tiers
GET
Get Application Flow Summary

Show application details
GET
Get App Flow Properties

Get application flow properties e.g flow count, count of interent flows etc
GET
Get App Flow Metrics

Get application flow properties sum of bytes of incoming and outgoing flows
GET
Get App Top Talking Members

List Application top talking members based on provided criteria
GET
Get App Top Talking Pairs

List Application top talking pairs based on provided criteria
GET
Get Saved Applications Summaries

Get the summaries of saved applications in bulk, by providing a list of entity IDs.
GET
List Application Tiers

List tiers of an application
POST
Add Tier

Create a tier of an application with specified membership criteria or members list. The membership criteria is defined in terms of virtual machines or IP addresses/subnet. Please refer to API Guide on how to construct membership criteria.
POST
Add Application With Tiers

Creates a manual application or saves discovered application. While saving discovered application user can curate it. This API also allows to merge multiple discovered application and save it as a single saved applicaiton. For merging application, customer should add criteria of tiers to be merged in one tier and similarly update rest of the imformation. Also, allows edit of saved application. To make sure changes are being applied on latest saved app, use "If-Match" header.
GET
Get Application Tier

Show application tier details
PUT
Edit Application Tier

Edit a tier of an application with specified membership criteria or members list. The membership criteria is defined in terms of virtual machines or IP addresses/subnet. Please refer to API Guide on how to construct membership criteria.
DELETE
Delete Tier

Delete application tier of an application
GET
Get Tier

Show application tier details
GET
Get Discovered Applications

Get the discovered application entity IDs.
GET
Get Discovered Application Summaries

Get the summaries of discovered applications in bulk, by providing a list of entity IDs.
GET
Get Application Updates

Get the details of the available updates for a saved application.
GET
Get FBAD Config Ids

Get a list of flow based application discovery configuration ids used for application and tier discovery
POST
Create FBAD Config

Create and save flow based configuration to be used for application and tier discovery. All the fields in the request JSON are optional and default configuration will be used for undefined fields. The order of discovery options will be honoured during application discovery if discovery options are defined in the input request. Please use API api/ni/groups/discovered-applications/custom-config/fbad/file/upload to upload a CSV file to be used for application and tier discovery and naming. Use the filepath in it's response in the values tag of discovery options and naming preferences, each of type CSV, as applicable.
GET
Get FBAD Config

Get the saved flow based configuration used for application and tier discovery
PUT
Update FBAD Config

Update the flow based configuration used for application and tier discovery. All the fields in the request JSON are optional and default configuration will be used for undefined fields. The order of discovery options will be honoured during application discovery if discovery options are defined in the input request. Please use API api/ni/groups/discovered-applications/custom-config/fbad/file/upload to upload a CSV file to be used for application and tier discovery and naming. Use the filepath in it's response in the values tag of discovery options and naming preferences, each of type CSV, as applicable.
DELETE
Delete FBAD Config

Delete the saved flow based configuration used for application and tier discovery
GET
Get FBAD Progress

Get the progress status of flow based application discovery of the input configuration id. It shows the progress status of flow based application discovery when a user creates a new configuration or updates the existing configuration. Updation of the existing configuration includes changing naming preferences, updating the CSV file used for application discovery and changing the scope. It can also be used to get the progress status when flow based application discovery is run for the first time.
GET
Get CSV Used For FBAD

Get the CSV being used for flow based application discovery
GET
Export FBADCSV Errors

Export all the errors to CSV from CSV being used for Flow Based Application Discovery
POST
Upload FBADCSV

Upload CSV file to be used for application and tier discovery and optionally for naming applications and tiers.
Authentication
POST
Create
VCF Operations for Networks supports token based authentication. Tokens are non-modifiable identifiers returned by the system when the user has successfully authenticated using valid credentials. Token expires after expiry time returned in the response. All API requests must provide the auth token in Authorization header in following format:
Authorization : NetworkInsight {token}
If a token is invalid or expired, 401-Unauthorized error gets returned in the response of the API request.
There is limit of 100 valid tokens per user and further requests will return 401-Unauthorized. So, users are advised to delete the tokens after use
Expired tokens are cleaned periodically by the system.
DELETE
Delete

Deletes the auth token provided in Authorization header. Deleting an expired or invalid token will result in 401 Unauthorized error.
POST
Create Vidm User Token
VCF Operations for Networks supports token based authentication. Tokens are non-modifiable identifiers returned by the system when the user has been successfully authenticated using valid access token provided by configured VMware Identity Manager appliance. Token expires after expiry time (returned in the response). All API requests must provide the auth token in Authorization header in following format:
Authorization : NetworkInsight {token}
If a token is invalid or expired, 401-Unauthorized error gets returned in the response of the API request.
GET
Get Vidm Oauth Clien Id

Get client-id of password grant OAuth client registered at VMware Identity Manager. This client-id along with user credentials is required while making an access token request to VMware Identity Manager.
Config
GET
Get Backup Configuration

Get Backup configuration
PUT
Update Backup Configuration

Update Backup configuration
POST
Add Backup Configuration

Configure backup of platform configuration; system settings, data sources, SMTP and SNMP settings, and more. This can be sent to a local filesystem, or a remove SSH or FTP server.
DELETE
Delete Backup Configuration

Delete existing Backup configuration.
GET
Get Backup Status

Get currently running or last Backup job status
GET
Get Restore Configuration

Get Restore configuration
POST
Add Restore Configuration

Configure restore of platform configuration and triggers restore operation. Must be done on a clean platform deployment.
DELETE
Delete Restore Configuration

Delete existing restore configuration.
GET
Get Restore Status

Get currently running or last Restore job status
Custom Dashboards
GET
Get All Custom Dashboards

Get the list of all custom dashboards for a user. By default size and cursor would be set to 10 and 0 respectively.
POST
Create Custom Dashboard

Create custom dashboard. Only admin and member users can perform this action
GET
Get Custom Dashboard

Get the specified custom dashboard.
PUT
Edit Custom Dashboard

Edit custom dashboard. Only admin and member users can perform this action.
DELETE
Delete Custom Dashboard

Delete custom dashboard. Only admin and member users can perform this action
POST
Create Custom Dashboard Pin

Create a pin for a custom dashboard. Only admin and member users can perform this action
PUT
Update Custom Dashboard Pin

Update the pin for given custom dashboard. Only admin and member users can perform this action
DELETE
Delete Custom Dashboard Pin

Delete the pin of the given custom dashboard. Only admin and member users can perform this action
POST
Duplicate Custom Dashboard

Creates duplicate of a given custom dashboard. Only admin and member users can perform this action
POST
Set Custom Dashboard Preference

Set upto 5 custom dashboards/OOTB dashboards as home page preference for a user
PUT
Share Custom Dashboard

Share custom dashboard with users and LDAP/vIDM groups. Only admin and member users can perform this action
PUT
Remove Share Custom Dashboard

Share custom dashboard with users and LDAP/vIDM groups. Only admin and member users can perform this action
Customers
POST
Rotate Proxy Key

Update default lifetime of the certificate and rotate current keys
GET
Get Proxy Key Rotation Status

Get status of update collector certificate request
GET
Get Proxy Key Details

Get details about collector ceritficate e.g. default lifetime, remaining validity etc.
Data Sources
GET
List Vcenters

List vCenter data sources
POST
Add Vcenter Datasource

Add a vCenter data source. You must provide one of IP or FQDN field in the request body. Appropriate proxy id is retrieved from /infra/nodes URL to select the proxy node.
GET
Get Vcenter

Show vCenter data source details
PUT
Update Vcenter

Update a vcenter data source. Only nickname, notes and credentials can be updated.
DELETE
Delete Vcenter

Delete a data source
POST
Enable Vcenter

Enable a vCenter data source
POST
Disable Vcenter

Disable a vCenter data source
POST
Validate V Center

Validate a vCenter data source. You must provide one of IP or FQDN field in the request body. Appropriate proxy id is retrieved from /infra/nodes URL to select the proxy node.
PUT
Accept Certificate

Accept certificate and thumbprint of a data source which was stopped due to certificate/thumbprint change
GET
List F5BIGIP

List F5 BIG-IP data sources
POST
Add F5BIGIP

Add a F5 BIG-IP Load Balancer as a data source
GET
Get F5BIGIP

Show F5 BIG-IP data source details
PUT
Update F5BIGIP

Update a F5 BIG-IP data source
DELETE
Delete F5BIGIP

Delete a F5 BIG-IP data source
POST
Enable F5BIGIP

Enable a F5 BIG-IP data source
POST
Disable F5BIGIP

Disable a F5 BIG-IP data source
GET
Get F5BIGIP Snmp Config

Show SNMP config for F5 BIG-IP data source
PUT
Update F5BIGIP Snmp Config

Update SNMP config for a F5 BIG-IP data source
GET
List Common Device

List Common Device data sources
POST
Add Common Device

Add a Common Device as a data source
GET
Get Common Device

Show Common Device data source details
PUT
Update Common Device

Update a Common Device data source
DELETE
Delete Common Device

Delete a Common Device data source
POST
Enable Common Device

Enable a Common Device data source
POST
Disable Common Device

Disable a Common Device data source
GET
Get Common Device Snmp Config

Show SNMP config for Common Device data source
PUT
Update Common Device Snmp Config

Update SNMP config for a Common Device data source
GET
Ds Pack List

List Data source pack identifiers
PUT
Ds Pack Upload

Upload Data Source pack in .bundle format
GET
List Huawei

List Huawei data sources
POST
Add Huawei

Add switch Datasource
GET
Get Huawei

Show Huawei data source details
PUT
Update Huawei

Update a Huawei data source
DELETE
Delete Huawei

Delete a Huawei data source
POST
Enable Huawei

Enable a Huawei data source
POST
Disable Huawei

Disable a Huawei data source
POST
Collect Config Now Huawei Switch

Collect Config now for a Huawei switch data source
GET
Get Huawei Snmp Config

Show SNMP config for Huawei data source
PUT
Update Huawei Snmp Config

Update SNMP config for a Huawei data source
POST
Bulk Data Source Operation

Submit request for bulk Operations
POST
Bulk Data Source Add Operation

Submit request to add data sources in bulk
GET
Get Bulk Operation Details

Show Bulk Operation Details
GET
List Generic Switch

List generic switch data sources
POST
Add Generic Switch

Add generic switch as data source.
GET
Get Generic Switch

Show generic switch data source details
PUT
Update Generic Switch

Update generic switch data source
DELETE
Delete Generic Switch

Delete generic switch data source
PUT
File Upload

Upload configuration of the generic data source in .zip format
POST
Enable Generic Switch

Enable generic switch data source
POST
Disable Generic Switch

Disable generic switch data source
GET
List HPE Switches

List HPE switch data sources
POST
Add HPE Switch

Add a HPE switch as data source
GET
Get HPE Switch

Show HPE switch data source details
PUT
Update HPE Switch Manager

Update a HPE switch data source
DELETE
Delete HPE Switch

Delete a HPE switch data source
POST
Enable HPE Switch

Enable a HPE switch data source
POST
Disable HPE Switch

Disable a HPE switch data source
POST
Collect Config Now HPE Switch

Collect Config now for a HPE switch data source
GET
Get HPE Switch Snmp Config

Show SNMP config for HPE switch data source
PUT
Update HPE Switch Snmp Config

Update SNMP config for HPE switch data source
GET
List Mellanox Switches

List Mellanox switch data sources
POST
Add Mellanox Switch

Add a Mellanox switch as data source
GET
Get Mellanox Switch

Show Mellanox switch data source details
PUT
Update Mellanox Switch Manager

Update a Mellanox switch data source
DELETE
Delete Mellanox Switch

Delete a Mellanox switch data source
POST
Enable Mellanox Switch

Enable a Mellanox switch data source
POST
Disable Mellanox Switch

Disable a Mellanox switch data source
POST
Collect Config Now Mellanox Switch

Collect Config now for a Mellanox switch data source
GET
Get Mellanox Switch Snmp Config

Show SNMP config for Mellanox switch data source
PUT
Update Mellanox Switch Snmp Config

Update SNMP config for Mellanox switch data source
GET
List Log Insight Data Source

List Operations for Logs data sources
POST
Add Log Insight Data Source

Add a Operations for Logs as data source
GET
Get Log Insight Data Source

Show Operations for Logs data source details
PUT
Update Log Insight Data Source

Update a Operations for Logs data source
DELETE
Delete Log Insight Data Source

Delete a Operations for Logs data source
POST
Enable Log Insight Data Source

Enable a Operations for Logs data source
POST
Disable Log Insight Data Source

Disable a Operations for Logs data source
GET
List Cisco ASRXR Switches

List Cisco ASR XR switch data sources
POST
Add Cisco ASRXR Switch

Add a Cisco ASR XR switch as data source
GET
Get Cisco ASRXR Switch

Show Cisco ASR XR switch data source details
PUT
Update Cisco ASRXR Switch Manager

Update a Cisco ASR XR switch data source
DELETE
Delete Cisco ASRXR Switch

Delete a Cisco ASR XR switch data source
POST
Enable Cisco ASRXR Switch

Enable a Cisco ASR XR switch data source
POST
Disable Cisco ASRXR Switch

Disable a Cisco ASR XR switch data source
POST
Collect Config Now Cisco ASR Switch

Collect Config now for a CiscoASR switch data source
GET
Get Cisco ASRXR Switch Snmp Config

Show SNMP config for Cisco ASR XR switch data source
PUT
Update Cisco ASRXR Switch Snmp Config

Update SNMP config for Cisco ASR XR switch data source
GET
List Cisco Switches

List Cisco switch data sources
POST
Add Cisco Switch

Add Cisco switch as data source. You must provide one of IP or FQDN field in the request body. Appropriate proxy id is retrieved from infra/nodes URL to select the proxy node.
GET
Get Cisco Switch

Show Cisco switch data source details
PUT
Update Cisco Switch

Update a Cisco switch data source. Only credentials, nickname and notes can be updated.
DELETE
Delete Cisco Switch

Delete a Cisco switch data source
POST
Enable Cisco Switch

Enable a Cisco switch data source
POST
Disable Cisco Switch

Disable a Cisco switch data source
POST
Collect Config Now Cisco Switch

Collect config now for a Cisco switch data source
GET
Get Cisco Switch Snmp Config

Show SNMP config for Cisco switch data source
PUT
Update Cisco Switch Snmp Config

Update SNMP config for Cisco switch data source
GET
Get Cisco Switch WAN Config

Show WAN config for Cisco switch data source. This will only work for Cisco ASR and ISR data sources.
PUT
Update Cisco Switch WAN Config

Update WAN config for Cisco switch data source. This will only work for Cisco ASR and ISR data sources.
GET
List Dell Switches

List Dell switch data sources
POST
Add Dell Switch

Add a Dell switch as data source
GET
Get Dell Switch

Get a Dell switch data source details
PUT
Update Dell Switch

Update a Dell switch data source. Only credentials, nickname and notes can be updated
DELETE
Delete Dell Switch

Delete a data source
POST
Enable Dell Switch

Enable a Dell switch data source
POST
Disable Dell Switch

Disable a Dell switch data source
POST
Collect Config Now Dell Switch

Collect config now for a Dell switch data source
GET
Get Dell Switch Snmp Config

Show SNMP config for Dell switch data source
PUT
Update Dell Switch Snmp Config

Update SNMP config for Dell switch data source
GET
List Dell Os10 Switches

List Dell os10 switch data sources
POST
Add Dell Os10 Switch

Add a Dell OS10 switch as data source
GET
Get Dell Os10 Switch

Get a Dell os10 switch data source details
PUT
Update Dell Os10 Switch

Update a Dell os10 switch data source. Only credentials, nickname and notes can be updated
DELETE
Delete Dell Os10 Switch

Delete a data source
POST
Enable Dell Os10 Switch

Enable a Dell os10 switch data source
POST
Disable Dell Os10 Switch

Disable a Dell os10 switch data source
POST
Collect Config Now Dell OS10 Switch

Collect config now for Dell OS 10 switch data source
GET
Get Dell Os10 Switch Snmp Config

Show SNMP config for Dell os10 switch data source
PUT
Update Dell Os10 Switch Snmp Config

Update SNMP config for Dell os10 switch data source
GET
List Brocade Switches

List Brocade switch data sources
POST
Add Brocade Switch

Add Brocade switch as a data source
GET
Get Brocade Switch

Show Brocade switch data source details
PUT
Update Brocade Switch

Update a Brocade switch data source. Only credentials, nickname and notes can be updated.
DELETE
Delete Brocade Switch

Delete a Brocade switch data source
POST
Enable Brocade Switch

Enable a Brocade switch data source
POST
Disable Brocade Switch

Disable a Brocade switch data source
POST
Collect Config Now Brocade Switch

Collect config now for Brocade switch data source
GET
Get Brocade Switch Snmp Config

Show SNMP config for Brocade switch data source
PUT
Update Brocade Switch Snmp Config

Update SNMP config for Brocade switch data source
GET
List Juniper Switches

List Juniper switch data sources
POST
Add Juniper Switch

Add a Juniper switch Datasource
GET
Get Juniper Switch

Show Juniper switch data source details
PUT
Update Juniper Switch

Update a Juniper switch data source
DELETE
Delete Juniper Switch

Delete a Juniper switch data source
POST
Enable Juniper Switch

Enable a Juniper switch data source
POST
Disable Juniper Switch

Disable a Juniper switch data source
POST
Collect Config Now Juniper Switch

Collect config now for Juniper switch data source
GET
Get Juniper Switch Snmp Config

Show SNMP config for Juniper switch data source
PUT
Update Juniper Switch Snmp Config

Update SNMP config for a Juniper switch data source
GET
List Arista Switches

List Arista switch data sources
POST
Add Arista Switch

Add Arista switch data source
GET
Get Arista Switch

Show Arista switch data source details
PUT
Update Arista Switch

Update an switch data source
DELETE
Delete Arista Switch

Delete an Arista switch data source
POST
Enable Arista Switch

Enable an Arista switch data source
POST
Disable Arista Switch

Disable an Arista switch data source
POST
Collect Config Now Arista Switch

Collect config now for Arista switch data source
GET
Get Arista Switch Snmp Config

Show SNMP config for Arista switch data source
PUT
Update Arista Switch Snmp Config

Update SNMP config for Arista switch data source
GET
List Checkpoint Firewalls

List Check Point firewall data sources
POST
Add Checkpoint Firewall

Add Check Point firewall as data source
GET
Get Checkpoint Firewall

Show Check Point firewall data source details
PUT
Update Checkpoint Firewall

Update a Check Point firewall data source
DELETE
Delete Checkpoint Firewall

Delete a Check Point firewall data source
POST
Enable Checkpoint Firewall

Enable a Check Point firewall data source
POST
Disable Checkpoint Firewall

Disable a Check Point firewall data source
POST
Collect Config Now Checkpoint Firewall

Collect config now for Check Point firewall data source
GET
List Panorama Firewalls

List Palo Alto Networks Panorama firewall data sources
POST
Add Panorama Firewall

Add Palo Alto Networks Panorama firewall as data source
GET
Get Panorama Firewall

Show Palo Alto Networks Panorama firewall data source details
PUT
Update Panorama Firewall

Update a Palo Alto Networks Panorama firewall data source
DELETE
Delete Panorama Firewall

Delete a Palo Alto Networks Panorama firewall data source
POST
Enable Panorama Firewall

Enable a Palo Alto Networks Panorama firewall data source
POST
Disable Panorama Firewall

Disable a Palo Alto Networks Panorama firewall data source
POST
Collect Config Now Panorama Firewall

Collect config now for Palo Alto Networks Panorama firewall data source
GET
List Fortinet Firewalls

List Fortinet firewall data sources
POST
Add Fortinet Firewall

Add Fortinet firewall as data source
GET
Get Fortinet Firewall

Show Fortinet firewall data source details
PUT
Update Fortinet Firewall

Update a Fortinet firewall data source
DELETE
Delete Fortinet Firewall

Delete a Fortinet firewall data source
POST
Enable Fortinet Firewall

Enable a Fortinet firewall data source
POST
Disable Fortinet Firewall

Disable a Fortinet firewall data source
POST
Collect Config Now Fortinet Firewall

Collect config now for Fortinet firewall data source
GET
List Ucs Managers

List Cisco UCS Manager data sources
POST
Add Ucs Manager

Add a Cisco UCS Manager as data source
GET
Get Ucs Manager

Show Cisco UCS Manager data source details
PUT
Update Ucs Manager

Update a Cisco UCS Manager data source
DELETE
Delete Ucs Manager

Delete a Cisco UCS Manager data source
POST
Enable Ucs Manager

Enable a Cisco UCS Manager data source
POST
Disable Ucs Manager

Disable a Cisco UCS Manager data source
GET
Get Ucs Snmp Config

Show SNMP config for Cisco UCS Manager
PUT
Update Ucs Snmp Config

Update SNMP config for Cisco UCS Manager
GET
List Cisco ACI

List Cisco ACI data sources
POST
Add Cisco ACI

Add a Cisco ACI as data source
GET
Get Cisco ACI

Show Cisco ACI data source details
PUT
Update Cisco ACI Manager

Update a Cisco ACI data source
DELETE
Delete Cisco ACI

Delete a Cisco ACI data source
POST
Enable Cisco ACI

Enable a Cisco ACI data source
POST
Disable Cisco ACI

Disable a Cisco ACI data source
POST
Collect Config Now Cisco ACI

Collect config now Cisco ACI data source
GET
Get Cisco ACI Snmp Config

Show SNMP config for Cisco ACI
PUT
Update Cisco ACI Snmp Config

Update SNMP config for Cisco ACI
GET
List Hpvc Managers

List HPVC manager data sources
POST
Add Hpvc Manager

Add HPVC manager data source
GET
Get Hpvc Manager

Show HPVC data source details
PUT
Update Hpvc Manager

Update a HPVC manager data source
DELETE
Delete Hpvc Manager

Delete a HPVC manager data source
POST
Enable Hpvc Manager

Enable a HPVC manager data source
POST
Disable Hpvc Manager

Disable a HPVC manager data source
GET
List Hpov Managers

List HP OneView manager data sources
POST
Add Hpov Manager

Add a HP OneView manager data source
GET
Get Hpov Manager

Show HP OneView data source details
PUT
Update Hpov Manager

Update a HP OneView data source
DELETE
Delete Hpov Manager

Delete a HP OneView data source
POST
Enable Hpov Manager

Enable a HP OneView data source
POST
Disable Hpov Manager

Disable a HP OneView data source
GET
List Nsxt Managers

List NSX-T Manager data sources
POST
Add Nsxt Manager Datasource

Add an NSX-T Manager data source
GET
Get Nsxt Manager

Show NSX-T Manager data source details
PUT
Update Nsxt Manager

Update an NSX-T Manager data source
DELETE
Delete Nsxt Manager

Delete an NSX-T Manager data source
POST
Enable Nsxt Manager

Enable an NSX-T Manager data source
POST
Disable Nsxt Manager

Disable an NSX-T Manager data source
GET
List NSXALB

List NSX Advanced Load Balancer data sources
POST
Add NSXALB Datasource

Add an NSX Advanced Load Balancer data source
GET
Get NSXALB

Show NSX Advanced Load Balancer data source details
PUT
Update NSXALB

Update an NSX Advanced Load Balancer data source
DELETE
Delete NSXALB

Delete an NSX Advanced Load Balancer data source
POST
Enable NSXALB

Enable an NSX Advanced Load Balancer data source
POST
Disable NSXALB

Disable an NSX Advanced Load Balancer data source
GET
List PKS

List VMware Tanzu Kubernetes Grid Integrated data sources
POST
Add PKS Datasource

Add an VMware Tanzu Kubernetes Grid Integrated data source
GET
Get PKS

Show VMware Tanzu Kubernetes Grid Integrated data source details
PUT
Update PKS

Update an VMware Tanzu Kubernetes Grid Integrated data source
DELETE
Delete PKS

Delete an VMware Tanzu Kubernetes Grid Integrated data source
POST
Enable PKS

Enable an VMware Tanzu Kubernetes Grid Integrated data source
POST
Disable PKS

Disable an VMware Tanzu Kubernetes Grid Integrated data source
GET
List Nsxv Managers

List NSX-v Manager data sources
POST
Add Nsxv Manager Datasource

Add an NSX-v Manager data source
GET
Get Nsxv Manager

Show NSX-v Manager data source details
PUT
Update Nsxv Manager

Update an NSX-v Manager data source
DELETE
Delete Nsxv Manager

Delete an NSX-v Manager data source
POST
Enable Nsxv Manager

Enable an NSX-v Manager data source
POST
Disable Nsxv Manager

Disable an NSX-v Manager data source
GET
Get Nsxv Controller Cluster

Show NSX-v Controller Cluster details
PUT
Update Nsxv Controller Cluster

Update NSX-v Controller Cluster details
GET
List Kubernetes Clusters

List Kubernetes cluster data sources
POST
Add Kubernetes Datasource

Add an Kubernetes cluster data source
GET
Get Kubernetes Cluster

Show Kubernetes cluster data source details
PUT
Update Kubernetes Cluster

Update an Kubernetes cluster data source
DELETE
Delete Kubernetes Cluster

Delete an Kubernetes cluster data source
POST
Enable Kubernetes Cluster

Enable an Kubernetes cluster data source
POST
Disable Kubernetes Cluster

Disable an Kubernetes cluster data source
GET
List Openshift Clusters

List OpenShift data sources
POST
Add Openshift Datasource

Add an OpenShift data source
GET
Get Openshift Cluster

Show OpenShift data source details
PUT
Update Openshift Cluster

Update an OpenShift data source
DELETE
Delete Openshift Cluster

Delete an OpenShift data source
POST
Enable Openshift Cluster

Enable an OpenShift data source
POST
Disable Openshift Cluster

Disable an OpenShift data source
GET
List Service Now Instances

List ServiceNow instance data sources
POST
Add Service Now Datasource

Add an ServiceNow instance data source
GET
Get Service Now Instance

Show ServiceNow instance data source details
PUT
Update Service Now Instance

Update an ServiceNow instance data source
DELETE
Delete Service Now Instance

Delete an ServiceNow instance data source
POST
Enable Service Now Instance

Enable an ServiceNow instance data source
POST
Disable Service Now Instance

Disable an ServiceNow instance data source
GET
List Infoblox Managers

List Infoblox DNS Manager data sources
POST
Add Infoblox Manager Datasource

Add an Infoblox DNS Manager data source
GET
Get Infoblox Manager

Show Infoblox DNS Manager data source details
PUT
Update Infoblox Manager

Update an Infoblox DNS Manager data source
DELETE
Delete Infoblox Manager

Delete an Infoblox DNS Manager data source
POST
Enable Infoblox Manager

Enable an Infoblox DNS Manager data source
POST
Disable Infoblox Manager

Disable an Infoblox DNS Manager data source
GET
List Policy Managers

List VMC NSX Manager data sources
POST
Add Policy Manager Datasource

Add a VMC NSX Manager data source
GET
Get Policy Manager

Show VMC NSX Manager data source details
PUT
Update Policy Manager

Update a VMC NSX Manager data source
DELETE
Delete Policy Manager

Delete a VMC NSX Manager data source
POST
Enable Policy Manager

Enable a VMC NSX Manager data source
POST
Disable Policy Manager

Disable a VMC NSX Manager data source
GET
List Azure Subscriptions

List Azure Cloud data sources
POST
Add Azure Datasource

Add an Azure Cloud data source
GET
Get Azure Subscriptions

Show Azure Cloud data source details
PUT
Update Azure Subscription

Update an Azure Cloud data source
DELETE
Delete Azure Subscription

Delete an Azure Cloud data source
POST
Enable Azure Subscription

Enable an Azure Cloud data source
POST
Disable Azure Subscription

Disable an Azure Cloud data source
GET
List Hcxs

List VMware HCX data sources
POST
Add Hcx Datasource

Add an VMware HCX data source
GET
Get Hcx

Show VMware HCX data source details
PUT
Update Hcx

Update an VMware HCX data source
DELETE
Delete Hcx

Delete an VMware HCX data source
POST
Enable Hcx

Enable an VMware HCX data source
POST
Disable Hcx

Disable an VMware HCX data source
GET
List Velo Cloud

List VMware SD-WAN by VeloCloud data sources
POST
Add Velo Cloud Datasource

Add a VMware SD-WAN by VeloCloud data source
GET
Get Velo Cloud

Show VMware SD-WAN by VeloCloud data source details
PUT
Update Velo Cloud

Update a VMware SD-WAN by VeloCloud data source
DELETE
Delete Velo Cloud

Delete a VMware SD-WAN by VeloCloud data source
POST
Enable Velo Cloud

Enable a VMware SD-WAN by VeloCloud data source
POST
Disable Velo Cloud

Disable a VMware SD-WAN by VeloCloud data source
GET
List AWS Data Sources

List AWS data sources
POST
Add AWS Datasource

Create an AWS data source
GET
Get AWS Data Source

Show AWS data source details
PUT
Update AWS Data Source

Update an AWS data source
DELETE
Delete AWS Data Source

Delete an AWS data source
POST
Enable AWS Data Source

Enable an AWS data source
POST
Disable AWS Data Source

Disable an AWS data source
GET
Get All

List Data Sources added to VCF Operations for Networks Filters can be applied on enabled, Collector and problem Few examples of filter clause

  • problem = 'Data Source Identity Information Change'
  • problem = 'Invalid credentials'
  • problem = 'Data Source is not reachable'
  • Enabled = 'false'
  • Collector = 'Collector_10.79.197.35'

Few examples of order_by clause

  • Collector
  • entity_type
GET
Get Datasource Health

List health of Data Sources added to VCF Operations for Networks
POST
Migrate Collector Data Sources

Migrate all Data Sources present on a collector to a new collector
GET
Get Migration Status

Get status of migration of all Data Sources present on a collector to a new collector
POST
Cancel Bulk Operation

Cancel migration of collector's data sources
Entities
GET
List Problem Events

List problem events.
GET
List problems

List problem event details.
POST
Bulk Fetch Problem Events

Bulk fetch of problems. Max batch size is 1000.
GET
Get Problem Event

Show problem event details.
GET
List Vms

List vms
GET
Get Vm

Show VM details
POST
Get details Of entities

Bulk fetch of entity details using a list of entity IDs. Max batch size is 1000.
GET
List Vnics

List vnics attached to virtual machines
GET
Get Vnic

Show vNIC details
GET
List Hosts

List vSphere hosts
GET
Get Host

Show vSphere host details
GET
List Clusters

List vSphere clusters
GET
Get Cluster

Show vSphere cluster details
GET
List Datacenters

List vCenter datacenters
GET
Get Datacenter

Show vCenter datacenter details
GET
List Folders

List vCenter folders
GET
Get Folder

Show vCenter folder details
GET
List Datastores

List vSphere datastores
GET
Get Datastore

Show vSphere datastore details
GET
List Vmknics

List ESXi host vmknics
GET
Get Vmknic

Show ESXi host vmknic details
GET
List Layer2 Networks

List layer2 networks (VLANs, VXLANs)
GET
Get Layer2 Network

Show layer2 network details
GET
List IP Sets

List NSX IP Sets
GET
Get IP Set

Show NSX IP Set details
GET
Get Flows

List network traffic flows
GET
Get Flow

Show network traffic flow details
GET
List Security Groups

List security groups (NSX, AWS, all security groups)
GET
Get Security Group

Show security group details
GET
List Security Tags

List security tags
GET
Get Security Tag

Show security tag details
GET
List Firewall Rules

List firewall rules for NSX, AWS, Azure, physical firewalls, anything that has firewall rules
GET
Get Firewall Rule

Show firewall rule details
GET
List Firewalls

List firewalls
GET
Get Firewall

Show firewall details
GET
List Services

List services (used in firewall rules)
GET
Get Service

Show service details
GET
List Service Groups

List service groups (used in firewall rules)
GET
Get Service Group

Show service group details (used in firewall rules)
GET
List Vcenter Managers

List vCenter managers
GET
Get Vcenter Manager

Show vCenter manager details
GET
List NSX Managers

List NSX managers
GET
Get NSX Manager

Show NSX manager details
GET
List NSXT Controllers

List of NSXT Controllers
GET
Get NSXT Controller

Show NSXT Controller details
GET
List NSXT Edge Clusters

List of NSXT Edge Clusters
GET
Get NSXT Edge Cluster

Show NSXT Edge Cluster details
GET
List NSXT Transport Nodes

List of NSXT Transport Nodes
GET
Get NSXT Transport Node

Show NSXT Transport Node details
GET
Get NSXT Edge Node CPU Cores

List of NSXT Transport Node CPU Cores
GET
Get NSXT Edge Node CPU Core By Id

Show NSXT Transport Node CPU Core details
GET
List NSXT Management Nodes

List of NSXT Management Nodes
GET
Get NSXT Management Node

Show NSXT Management Node details
GET
List Firewall Managers

List firewall managers
GET
Get Firewall Manager

Show firewall manager details
GET
List Distributed Virtual Switches

List distributed virtual switches
GET
Get Distributed Virtual Switch

Show distributed virtual switch details
GET
List Distributed Virtual Portgroups

List distributed virtual portgroups
GET
Get Distributed Virtual Portgroup

Show distributed virtual portgroup details
POST
Get Names

Get names for entities.Limit of 1000 entities in a single request.
GET
Get Name

Get name of an entity
GET
List Azure Subscription

List Microsoft Azure Subscriptions
GET
Get Azure Subscription

Show Microsoft Azure Subscription details
GET
Get Logical Routers

Lists all Logical Routers
GET
Get Logical Router

Show Logical Router details
GET
List Routerinterfaces

List Router Interfacse
GET
Get Router Interface

Show Router Interface details
GET
List AWS Account Managers

List AWS Account managers
GET
Get AWS Account Manager

Show AWS Account manager details
GET
Get Vmc AWS Dx Connections

Lists all VMC AWS Direct Connect
GET
Get Vmc AWS Dx Connection

Show VMC AWS Direct Connect details
GET
Get VM Ware Transit Gateways

Lists all VMware Transit Gateways
GET
Get VM Ware Transit Gateway

Show VMware Transit Gateway details
GET
Get IP Sec VPN Sessions

Lists all IPSec VPN Sessions
GET
Get IP Sec VPN Session

Show IPSec VPN Session details
GET
Get VMCSDD Cs

Lists all VMC SDDCs
GET
Get VMCSDDC

Show VMC SDDC details
GET
Get Sddc Groups

Lists all VMC SDDC Groups
GET
Get Sddc Group

Show VMC SDDC Group details
GET
Get Direct Connect Interfaces

Lists all Direct Connect Interfaces
GET
Get Direct Connect Interface

Show Direct Connect Interface details
GET
List Switchports

List switch ports
GET
Get Switch Port

Show Switch Port details
GET
Get HCX Managers

Lists all HCX Managers
GET
Get HCX Manager

Show HCX Manager details
GET
Get HCX Sites

Lists all HCX Sites
GET
Get HCX Site

Show HCX Site details
GET
Get HCX Appliances

Lists all HCX Appliances
GET
Get HCX Appliance

Show HCX Appliance details
GET
Get HCX Tunnels

Lists all HCX Tunnels
GET
Get HCX Tunnel

Show HCX Tunnels details
GET
Get HCXL2 Extensions

Lists all HCX L2 Extensions
GET
Get HCXL2 Extension

Show HCX L2 Extension details
GET
Get HCX Service Meshes

Lists all HCX Service Meshes
GET
Get HCX Service Mesh

Show HCX Service Mesh details
GET
Get HCX Services

Lists all HCX Services
GET
Get HCX Service

Show HCX Services details
GET
Get HCX Network Profiles

Lists all HCX Network Profiles
GET
Get HCX Network Profile

Show HCX Network Profile details
GET
Get HCX Compute Profiles

Lists all HCX Compute Profiles
GET
Get HCX Compute Profile

Show HCX Compute Profile details
GET
Get Virtual Disks

Lists all Virtual Disks
GET
Get Virtual Disk

Show Virtual Disk details
GET
Get Kubernetes Cluster Entities

List Kubernetes Clusters
GET
Get Kubernetes Cluster Entity

Show Kubernetes Cluster details
GET
List Kubernetes Namespaces

List Kubernetes Namespaces
GET
Get Kubernetes Namespace

Show Kubernetes Namespace details
GET
List Kubernetes Nodes

List Kubernetes Nodes
GET
Get Kubernetes Node

Show Kubernetes Node details
GET
List Kubernetes Pods

List Kubernetes Pods
GET
Get Kubernetes Pod

Show Kubernetes Pod details
GET
List Kubernetes Services

List Kubernetes Services
GET
Get Kubernetes Service

Show Kubernetes Service details
POST
Bulk Fetch Vendor Info

Bulk fetch of vendor info. Max batch size is 1000.
Guided Network Troubleshooting
GET
List Troubleshooting Incidents

Shows Guided Network Troubleshooting incidents
POST
Create Troubleshooting Incident

Creates Guided Network Troubleshooting incident
GET
Get Troubleshooting Incident

Shows Guided Network Troubleshooting incident
PUT
Update Troubleshooting Incident

Updates Guided Network Troubleshooting incident
DELETE
Delete Troubleshooting Incident

Removes Guided Network Troubleshooting incident
Incomplete Tcp Flow Sessions
POST
Csv Export Incomplete Sessions

Export Incomplete TCP flow Sessions in csv file
GET
List Incomplete Sessions

Get drill down of the incomplete tcp sessions for a specific destination virtual machine in a specific time interval.
Info
GET
Get Version

Show version info
Infrastructure
GET
List Nodes

Get list of infrastructure nodes. Only admin users can retrieve this information.
GET
List Expanded Nodes

Get list of infrastructure nodes with all details. Only admin users can retrieve this information.
GET
Get Node

Get details of infrastructure nodes. Only admin users can get this information. The proxy id is required for adding a data source for selecting appropriate proxy node to add the data source.
DELETE
Delete Node

The proxy id is required for deleting a proxy node which can either be NodeId or model key. Examples : 10000:901:649591578347200326 (id) or IAPG7M8JS18458ROSJQRGQ0LLV (node_id). Only the admin user can perform this operation. Only the proxy nodes can be deleted using this API.
GET
Get VCF Watermark

Retrieve the saved watermark for VMware Cloud Foundation (VCF) watermark. Only admin/auditor users can perform this action.
PUT
Update VCF Watermark

Update the existing VMware Cloud Foundation (VCF) watermark. Only admin users can perform this action.
POST
Save VCF Watermark

Every product in the VMware Cloud Foundation (VCF) should mark themselves as deployed by VCF by including watermark information. Only admin users can perform this action.
DELETE
Delete VCF Watermark

Delete VMware Cloud Foundation (VCF) watermark. Only admin users can perform this action.
Intents
POST
Create Intent

Intent Creation
GET
Get Intent

Intent Fetch
PUT
Update Intent

Intent Updation
DELETE
Delete Intent

Intent Deletion
POST
Intent Enable

Intent Enable
POST
Intent Disable

Intent Disable
Logs
POST
Get Audit Logs

get audit logs based on filters specified in query
Metrics
GET
Get Metrics Deprecated

This api is deprecated. Please use /metrics/v2 Get metric points for an entity for an entity id and metric for a given time interval. Maximum number of metrics point returned by API is 300. In case the interval and time period combination have more than 300 metrics points, client should break the time period to multiple batches to get all the metrics points. These metric points are the points inside the metric charts (CPU, network rate, etc.)
GET
Get Metrics V2

Get metric points for an entity for an entity id and metric for a given time interval. Maximum number of metrics point returned by API is 300. In case the interval and time period combination have more than 300 metrics points, client should break the time period to multiple batches to get all the metrics points. These metric points are the points inside the metric charts (CPU, network rate, etc.)
POST
Fetch Bulk Metrics Deprecated

This api is deprecated. Please use /metrics/fetch/v2. Get metric points for multiple entity ids and metric for a given time interval. All the entity ids should belong to the same entity type. Maximum number of metrics point per entity returned by API is configurable. Default is 300. In case the interval and time period combination have more than 300 metrics points, client should break the time period to multiple batches to get all the metrics points.
POST
Fetch Bulk Metrics V2

Get metric points for multiple entity ids and metric for a given time interval. All the entity ids should belong to the same entity type. Maximum number of metrics point per entity returned by API is configurable. Default is 300. In case the interval and time period combination have more than 300 metrics points, client should break the time period to multiple batches to get all the metrics points.
Microsegmentation
POST
List Recommended Rules

Get recommended firewall rules based on the flow data gathered by VCF Operations for Networks. This API provides service to retrieve recommended rules based on flow traffic that is observed between two groups OR for a single group based on all the inbound and outboud traffic for that group. In case two groups are provided, both the groups should be of same type. Currently supported groups are Application, Tier, NSXSecurityGroup, EC2SecurityGroup.
POST
Export Nsx Recommended Rules

Export recommended firewall rules based on the flow data gathered by VCF Operations for Networks in NSX-V compatible format. The output will be a .zip file download.
POST
Get Entity Communication Summary

Get the topology for the request entity as well as the metrics information based on the flow data gathered by VCF Operations for Networks
POST
Get Connection Graph

Get the connection graph for the specified object type
Migration
GET
Get Migration Wave Deprecated

Get migration wave. Fetch based on group type
POST
Enable Migration Wave Deprecated

Enable migration wave computation
POST
Disable Migration Wave Deprecated

Disable migration wave computation
Path
POST
Path Firewall Rules

Get firewall rules applicable in path for a client IP and server IP for specified port/protocol.
Pinboards
GET
Get All Pinboards Deprecated

This api is deprecated. Please use custom dashboard api instead.
POST
Create Pinboard Deprecated

This api is deprecated. Please use custom dashboard api instead.
GET
Get Pinboard Deprecated

This api is deprecated. Please use custom dashboard api instead.
PUT
Edit Pinboard Deprecated

This api is deprecated. Please use custom dashboard api instead.
DELETE
Delete Pinboard Deprecated

This api is deprecated. Please use custom dashboard api instead.
POST
Create Pin Deprecated

This api is deprecated. Please use custom dashboard api instead.
PUT
Update Pin Deprecated

This api is deprecated. Please use custom dashboard api instead.
DELETE
Delete Pin Deprecated

This api is deprecated. Please use custom dashboard api instead.
POST
Duplicate Pinboard Deprecated

This api is deprecated. Please use custom dashboard api instead.
POST
Set Pinboard As Homepage Deprecated

This api is deprecated. Please use custom dashboard api instead.
PUT
Share Pinboard Deprecated

This api is deprecated. Please use custom dashboard api instead.
PUT
Remove Share Pinboard Deprecated

This api is deprecated. Please use custom dashboard api instead.
Schema
GET
Get Metrics Schema

Get details of metrics available for entity type
GET
Bulk Fetch Event Meta Info

Bulk fetch of event meta info. Max batch size is 1000.
Search
POST
Search

Using search QL API you can execute search by specifying search query directly as you specify on the UI. A successful search execution will return one of the following three things :

  1. List of entity ids that matches the search criteria.
  2. List of aggregations.
  3. List of groups.
POST
Search Entities

Using search API you can search VCF Operations for Networks 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
Aggregate Search Results

Using aggregate API you can aggregate search results for VCF Operations for Networks entities by specifying entity type, filter expression and aggregate clause. Please refer to API Guide on details of how to construct filter expression and aggregate clause. A successful search request will return a list of aggregations.
POST
Group Search Results

Using groupby search API you can group search results for VCF Operations for Networks entities by specifying entity type, filter expression, aggregate clause and groupby clause. Please refer to API Guide on details of how to construct filter expression, aggregate clause and groupby clause. A successful search request will return a list of groups.
Settings
GET
Get Ip Tag Ids Deprecated

Get all tag IDs e.g. EAST_WEST, INTERNET etc. These are used in the flow tags.
GET
Get Ip Tag Deprecated

Show IP tag details with member IP addresses and subnets
POST
Add Ip Tag Deprecated

Tag IP addresses with tag-id
POST
Remove Ip Tag Deprecated

Remove tag from IP addresses
GET
Get Tag Ids V2

Get all tag IDs e.g. EAST_WEST, INTERNET etc. These are used in the flow tags.
GET
Get Ip Tag V2

Show IP tag details with member IP addresses and subnets
POST
Add Tag V2

Tag IP addresses with tag-id
POST
Remove Tag V2

Remove tag from IP addresses
GET
Get Subnet Mappings

Get all subnet mappings (CIDR to VLAN ID).
POST
Create Subnet Mapping

Create a new subnet mapping (CIDR to VLAN ID). Physical to physical flows (without the switches added as a data source) can be linked to a VLAN ID with to these mappings.
PUT
Update Subnet Mapping

Update an existing subnet mapping (VLAN ID for the given CIDR).
DELETE
Delete Subnet Mapping

Delete an existing subnet mapping (CIDR to VLAN ID).
GET
Get Certificate

Get certificate for given url
GET
Get Vidm Configuration

Retrieve the saved configuration of VMware Identity Manager in VCF Operations for Networks. Only admin users can retrieve this information.
PUT
Update Vidm Configuration

Update the existing VMware Identity Manager configuration. Only admin users can perform this action.
POST
Save Vidm Configuration

VCF Operations for Networks supports SSO authentication through VMware Identity Manager. To authenticate against a particular VMware Identity Manager appliance, it must be configured and enabled in VCF Operations for Networks. Only admin users can perform this action.
DELETE
Delete Vidm Configuration

Delete the existing VMware Identity Manager configuration. Only admin users can perform this action.
POST
Enable Vidm

Enable VMware Identity Manager integration. Only admin users can perform this action.
POST
Disable Vidm

Disable VMware Identity Manager integration, although it will not delete the configuration. Only admin users can perform this action.
PUT
Update Vidm User Group Role

Update role for user-group mapped through VMware Identity Manager. Only admin users can perform this action.
POST
Add Vidm User Group

Add a new VMware Identity Manager user-group to VCF Operations for Networks. Only admin users can perform this action. VMware Identity Manager must be configured prior to this action.
GET
Get User Groups

Retrieve the list of existing user-groups. Only admin users can retrieve this information. This action is currently restricted to user-groups mapped through VMware Identity Manager.
GET
Get User Group

Get details of a user-group. Only admin users can perform this action. This action is currently restricted to user-group mapped through VMware Identity Manager.
DELETE
Delete User Group

Delete an existing user-group. Only admin users can perform this action. This action is currently restricted to user-group mapped through VMware Identity Manager
PUT
Update Vidm User Role

Update role for user mapped through VMware Identity Manager. Only admin users can perform this action.
POST
Add Vidm User

Add a new VMware Identity manager user to VCF Operations for Networks. Only admin users can perform this action. VMware Identity Manager must be configured prior to this action.
GET
Get Users

List the existing users. Only admin users can retrieve this information. This action is currently restricted to users mapped through VMware Identity Manager
GET
Get All Users

List all the existing users. Only admin users can retrieve this information. This action is currently restricted to users mapped through VMware Identity Manager
GET
Get User

Get details of a user. Only admin users can perform this action. This action is currently restricted to user mapped through VMware Identity Manager
DELETE
Delete User

Delete an existing user. Only admin users can perform this action. This action is currently restricted to user mapped through VMware Identity Manager
PUT
Update user password

Update password of a local user. Any user can change his own password. Admin has permission to change any user password.
GET
Get Web Proxies

List of configured web proxy servers. Only admin and audit users can retrieve this information.
POST
Add Web Proxy

Add new Web Proxy server. By Default, maximum of 10 web proxy servers can be configured. Only admin users can perform this action.
GET
Get Web Proxy

Get details of an existing Web Proxy Server. Only admin and audit users can perform this action.
PUT
Update Web Proxy

Update the details of an existing Web Proxy Server. Only admin can perform this action.
DELETE
Delete Web Proxy

Delete an existing existing Web Proxy Server. Only admin user can perform this action.
POST
Validate Connections Via Web Proxy

Validate the connections with the updated web proxy settings. Only admin users can perform this action.
POST
Validate Web Proxy Migration

Validate the connections when migrating from one web proxy to another. Only admin users can perform this action.
GET
Get Connected Clients To Web Proxy

Get details of connected clients to Web Proxy Server. Only admin and audit users can perform this action.
GET
Get Infra Nodes Web Proxy

Get web proxy for infra nodes. Only admin and audit users can perform this action.
GET
Get SNMP Engine Id

Output SNMP Engine ID for v3 traps. Only admin users can retrieve this information.
PUT
Update SNMP Engine Id

Update SNMP engine ID. It should be a valid hexadecimal string of even length between 10 to 64. Only admin users can perform this action.
GET
List the configured SNMP Trap destination profiles

List the configured SNMP Trap destination profiles. Only admin users can retrieve this information.
POST
Add new SNMP Trap destination profile

Add a new SNMP destination profile. By Default, maximum of 4 SNMP Trap profiles can be configured. Only admin users can perform this action.
POST
Send Test trap To SNMP destination profile

Send Test trap to SNMP destination profile. Only admin users can perform this action.
GET
Get details Of An existing SNMP destination profile

Get details of an existing SNMP Trap destination profile. Only admin users can perform this action.
PUT
Update An existing SNMP destination profile

Update an existing SNMP Trap destination profile. Only admin users can perform this action.
DELETE
Delete An existing SNMP Trap destination profile

Delete an existing SNMP destination profile. Only admin users can perform this action.
POST
Migrate event subscriptions To other SNMP Trap destination profiles

Migrate event subscriptions from given SNMP profile to multiple other SNMP Trap destination profiles.
GET
Get All Search Based Alert Configs

List all Search Based Alert Configurations (User Defined Alert Configurations).
POST
Add Search Based Alert Config

Add a new Search Based Alert Configuration (User Defined Alert Configuration).
POST
Enable Search Based Alert Config

Enable an existing Search Based Alert Configuration (User Defined Alert Configuration).
POST
Disable Search Based Alert Config

Disable an existing Search Based Alert Configuration (User Defined Alert Configuration).
GET
Get Search Based Alert Config

Get details of an existing Search Based Alert Configuration (User Defined Alert Configuration).
PUT
Update Search Based Alert Config

Update an existing Search Based Alert Configuration (User Defined Alert Configuration).
DELETE
Delete Search Based Alert Config

Delete an existing Search Based Alert Configuration (User Defined Alert Configuration).
GET
Get All User Defined Events Deprecated

List the created User Defined Event defintions.
POST
Create User Defined Event Deprecated

Add new User-Defined event.
POST
Enable User Defined Event Deprecated

Enable an existing User-Defined event.
POST
Disable User Defined Event Deprecated

Disable an existing User-Defined event.
GET
Get User Defined Event Deprecated

Get details of an existing User-Defined event.
PUT
Update User Defined Event Deprecated

Update an existing User-Defined event.
DELETE
Delete User Defined Event Deprecated

Delete an existing User-Defined event.
GET
Get Backup Config

Get Backup configuration
PUT
Update Backup Config

Update Backup configuration
POST
Add Backup Config

Configure backup of platform configuration; system settings, data sources, SMTP and SNMP settings, and more. This can be sent to a local filesystem, or a remove SSH or FTP server.
DELETE
Delete Backup Config

Delete existing Backup configuration.
GET
Get Backup Status Report

Get currently running or last Backup job status
GET
Get Restore Config

Get Restore configuration
POST
Add Restore Config

Configure restore of platform configuration and triggers restore operation. Must be done on a clean platform deployment.
DELETE
Delete Restore Config

Delete existing restore configuration.
GET
Get Restore Status Report

Get currently running or last Restore job status
GET
Get Licenses

Get information for current licenses and license usage
POST
Validate Serial Number Deprecated

This API is deprecated.
POST
Activate Serial Number Deprecated

This API is deprecated.
DELETE
Deactivate Serial Number Deprecated

This API is deprecated
GET
Get All Subscriber

Get the list of 'Databus' subscriptions
POST
Create Subscriber

Create subscription to receive data related to a 'message group' from 'Databus'. All the data related to the message group will be sent to the registered 'receiver url'.
GET
Get Subscriber

Retrieve a Databus subscription by specifying the ID of the subscription
PUT
Update Subscriber

Update subscription to receive data related to a 'message group' from 'Databus'. Receiver url of the subscription can be updated. Message group cannot be updated after creation of the subscription. If there is a requirement to change the message group, a new subscription can be created after deleting the subscription.
DELETE
Delete Subscriber

Delete a Databus subscription by specifying the ID of the subscription
GET
Get Certificates Details

Retrieves details of all certificates installed on vRNI
PUT
Update Certificate

Updates a certificate
GET
Fetch Certificates Update Status

Get certificate update status
GET
Fetch Certificate Update Status For Update Id

Get certificate update status for certificate id
GET
Get Login Banner

Get login banner details. All users can retrieve this information.
PUT
Update Login Banner

Update existing login banner. Only admin users can perform this action.
POST
Add Login Banner

Add new login banner. By Default, maximum of 1 login banner can be configured. Only admin users can perform this action.
DELETE
Delete Login Banner

Delete login banner. Only admin users can perform this action.
GET
Get Syslog Target List

List of Syslog targets.
POST
Add Syslog Target

Add syslog server. Only admin users can perform this action.
PUT
Update Syslog Target

Update syslog server. Only admin users can perform this action.
DELETE
Delete Syslog Target

Delete syslog server. Only admin users can perform this action.
POST
Send Syslog Test Message

Send test log to syslog server. Only admin users can perform this action.
GET
Get Syslog Mapping

Get syslog server mappings. Only admin users can perform this action.
POST
Update Syslog Mapping

Map and Unmap platform, proxy(or collector) and Ni Alert to a syslog server. Only admin users can perform this action.
GET
Get Syslog Status

Get status of the syslog. The states describes whether the syslog is enabled or disabled.
PATCH
Update Syslog Status

Enable/Disable syslog functionality. Only admin users can perform this action.