NetFlow
Use the following syntax:
https://{server}/api-flow?password={pw};{option}={value};...
| Option | Value |
|---|---|
| exporter | {exporter IP} |
| time | {increments of 5 minutes} |
| show | src_ip,dst_ip src_host,dst_host src_idx,dst_idx src_as,dst_as geo,tos,proto,pkt,oct,flow,conv |
| sort | src_ip | dst_ip | src_idx | dst_idx |src_as | dst_as | pkt | oct | flow | conv |
| proto | {protocol}.{service} |
| src_ip dst_ip any_ip both_ip | {ip filter} |
| src_as dst_as any_as both_as | {Autonomous System Filter} |
| src_idx dst_idx any_idx both_idx | {Index Filter Number} |
| sort_dir | f | r |
To activate the NetFlow web API:
Go to Admin > API > Web API Settings.
Click the NetFlow option On.
Click Save.
User api-ro is required.
NetFlow timeseries
Use the following syntax:
https://{server}/api-flow-timeseries?password={pw};{option}={value};...
| Option | Value |
|---|---|
| exporter | {exporter IP} |
| time | {time filter} |
| interval | {increments of 5 minutes} |
| proto | {protocol}.{service} |
| src_ip dst_ip any_ip both_ip | {ip filter} |
| src_as dst_as any_as both_as | AS Number | Name | Regex |
| src_idx dst_idx any_idx both_idx | {ifIndex} |
| tos | {number} |
Example
Retrieve five-minute time-series values for all flow records on a specific exporter:
https://{server}/api-flow-timeseries?password={pw};exporter=10.0.0.254;time=last4h;interval=5
Activate the NetFlow time-series web API:
Go to Admin > API > Web API Settings.
Click the NetFlow Time-series option On. Click
Save.
User api-ro is required.