340
edits
REST API description: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
== General == | |||
== | |||
All statistics of the Allegro Network Multimeter are requested as HTTP requests and provided as a JSON object. | All statistics of the Allegro Network Multimeter are requested as HTTP requests and provided as a JSON object. | ||
| Line 39: | Line 7: | ||
The credentials are the same as of the web interface. A non-admin user has read access to most of the statistics. | The credentials are the same as of the web interface. A non-admin user has read access to most of the statistics. | ||
== Examples == | |||
== | |||
In this section some examples are given using PowerShell and Linux curl and jq commands. | In this section some examples are given using PowerShell and Linux curl and jq commands. | ||
==== SSL certificate errors ==== | |||
If the default self-signed SSL certificate is used, curl and PowerShell are displaying error messages. You can either | If the default self-signed SSL certificate is used, curl and PowerShell are displaying error messages. You can either | ||
| Line 61: | Line 27: | ||
|} | |} | ||
==== Statistics about MAC or IP addresses ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 69: | Line 34: | ||
|} | |} | ||
==== Pretty displaying JSON output with jq ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 76: | Line 40: | ||
|} | |} | ||
==== Traffic counters ==== | |||
Traffic counters are represented as an JSON array with at least 4 lines. The structure is as follows: | Traffic counters are represented as an JSON array with at least 4 lines. The structure is as follows: | ||
| Line 92: | Line 55: | ||
* intervalPerSecond: Average per second value of the selected time interval. If no interval is specified, this is similar to lastSecond. | * intervalPerSecond: Average per second value of the selected time interval. If no interval is specified, this is similar to lastSecond. | ||
==== Time interval selection ==== | |||
Requests can be given a time interval. Following GET parameters are necessary: | Requests can be given a time interval. Following GET parameters are necessary: | ||
| Line 99: | Line 61: | ||
* timespan: Duration of the interval selection in seconds | * timespan: Duration of the interval selection in seconds | ||
==== Extract received bytes of the last second of a certain IP ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 107: | Line 68: | ||
|} | |} | ||
==== Extract received and transmitted bytes of the last second of a certain IP ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 114: | Line 74: | ||
|} | |} | ||
==== Extract received and transmitted bytes in a time interval (18/06/11 9:00 - 10:00) of a certain IP ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 122: | Line 81: | ||
|} | |} | ||
==== List queries ==== | |||
List queries are requested with pagination parameters to reduce the size of the resulting JSON object and to in- | List queries are requested with pagination parameters to reduce the size of the resulting JSON object and to in- | ||
| Line 143: | Line 101: | ||
* values: Amount of maximal values in history object | * values: Amount of maximal values in history object | ||
==== Show IP address with the highest amount of traffic ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 158: | Line 115: | ||
|} | |} | ||
==== Show all peers of a certain IP address ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 167: | Line 122: | ||
|} | |} | ||
==== Capture a certain IP ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 175: | Line 129: | ||
|} | |} | ||
==== Capture two IP addresses with ports on a certain layer 4 protocol ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 184: | Line 136: | ||
|} | |} | ||
==== PCAP parameters ==== | |||
Following parameters are possible: | Following parameters are possible: | ||