Versa Analytics REST API Overview

For supported software information, click here.

Versa Analytics provides REST APIs so that you can retrieve information about the Analytics devices and the log data collected by the devices. You can retrieve the following types of information:

• List of authenticated users
• List of error codes returned by the data API calls
• System information about disk, and CPU, usage; cluster drivers; and collectors
• Global information about tenants (organizations) and tenant Versa Operating System^TM (VOS^TM) devices (appliances)
• Next-generation firewall (NGFW) information and statistics
• Stateful firewall information and statistics
• Carrier-grade NAT (CGNAT) information and statistics
• SD-WAN information and statistics, including SLA and QoS statistics and packet capture (PCAP) files
• Tenant system information about application monitoring, guest VNFs/SNGs, and LTE usage.
• Configuration information for Versa Director and Versa Analytics nodes.

Using the REST APIs, you can perform the following operations:

• Log in and logout of Analytics clusters and nodes.
• Delete tenants, SD-WAN sites, SD-WAN VOS devices, and SD-WAN access circuits.
• Delete usage and reporting data.

The following PDF file describes the Analytics REST API calls and how to use them. These APIs are for Release 21.1.

• Versa Analytics 21.1 API Reference Guide

To display the Analytics REST API calls available on your Analytics node, select Administration > Tools > Documentation in the left menu bar, and then click the API Documentation field. You can also go to the URL https://analytics-ip-address/versa/analytics/docs/index.html.