On Prem Analytics - Use API to query AppFlow data

11/24/2023 4 People found this article helpful 328,305 Views

Description

API can be used to query data from a flow based On Premise Analytics server.

This article will show you how to perform a basic query using the API explorer accessible from within the Analytics application.

1) Create an API key to be used when authenticating to the Analytics server

Navigate to the Console tab, then 3^rd Party>API Keys
Select the tab for Generate New Key
Populate the requested data for the new Key

Once finished the key will be displayed under the Key Assignments tab.

2) Identify the API you would like to query. Available APIs can be found with the Analytics application using the Light Bulb icon in the top right of the screen.

We will use the System Information API for this example:

The API key is the only parameter needed for this API, other APIs may require specific info such as start/end time and/or device serial number.

3) Try out the API in the API Explorer you accessed from the Analytics appliance.

Expand the API you wish to test and click “Try it out”
Input the API key generated in Step 2
Click “Execute”

You can then verify the Response body returned by the API

After executing the API explorer will also provide a Curl that can used with other API clients or tools such as Command Prompt.

**The above API is a simple query that only requires the API key for querying the System Status. Other APIs may require that you input much more information, such as Firewall Serial number or timestamps. Be sure to provide the appropriate information for the API being tested.

Not Finding Your Answers?

ASK THE COMMUNITY

Was This Article Helpful?

YES NO

On Prem Analytics - Use API to query AppFlow data

Description

Related Articles

Categories

Not Finding Your Answers?

Was This Article Helpful?

Article Helpful Form

Article Not Helpful Form

Follow Us

Subscribe to newsletter

Stay In Touch