Child pages
  • opFlow 3.0 API Reference
Skip to end of metadata
Go to start of metadata

 

Authentication

Authentication is required to access all methods listed below.

POST login (authenticate)

POST /en/omk/opFlow/login

Authenticate to opFlow. 

Request

ParameterDescription
usernameThe username to authenticate with
passwordThe password for the user

Successful Response

A cookie is created and sent with the response.  This must be saved and passed with all requests below.  

Obtaining data from the API

Get Request, submitting the parameters required on the table below.

GET /en/omk/opFlow/data_model_view/new.json?requestData={"parameters":{}}

Common Parameters and Required Parameters

Many of the parameters are common over all calls and are used when they make sense.

Some parameters are required and marked with a font wight: bold.

Parameters

ParameterDescription
start_date_rawEpoch time to start the time period.
end_date_rawEpoch time to end the time period.
group_by

Accepts a List of values.

Values: "application", "src_ip", "dst_ip",etc.

e.g: To group by "Application Conversations"

"group_by":["src_ip","dst_ip","application"]

Note: This parameter is required and needs at least to be set to one value to work.

flow_type

Accepts a list of values, is used to specify the summary type.

Summary typeValue
App Sources["src_ip","application"]
App Destinations ["dst_ip","application"]
Applications["application"]
TOS[“tos”]
Talkers ["src_ip"]
Listeners ["dst_ip"]
options

Is a has and accepts the following parameters:

ParameterPossible value
limitnumber of rows to return
sort:

Accepts a Hash of values

e.g: {"octets":-1}

only_reply_dataSet to true to only receive the reply data, if set to false, the request data will be also returned.
ParameterDescription
model

The model used to obtain the flow summaries.

Value must be set to: "opFlow_flows_summary"


Model view

ParameterDescription
model_view

Set value to: "raw"

Return the data in JSON format.

 

It is possible to do a search with the following argument passed to the request.

argumentoptions
&search={ }

Accepts a hash of values, but only one can be use at a time.

 

Possible values to search by "Applications", "Source", "Source Port", "Destination" and "Destination Port"

"application":"regex:abc"

"dnsname_src_ip":"regex:abc"

"src_port":"portNumber"

"dnsname_dst_ip":"regex:abc"

"dnsname_dst_ip":"regex:abc"

"dst_port":"portNumber"


Where abc is a string or text to search for.

TopN

Required Parameters (along with common parameters)

To obtain TopN data. The TopN limit must be set in the option list.

 

ParameterDescription
options

Is a has and accepts the following parameters:

ParameterPossible value
limitnumber of rows to return



Request example output:

Get Top 5 Applications from  October 10. 2018 4:22:00 PM GMT+10:00 (1539152520) to October 10, 2018 6:22:00 PM GMT+10:00 (1539159720), sorted by octets (bytes) in descending order, getting only reply data.

   Response

  • No labels