340
edits
REST API description: Difference between revisions
→General API Setup
No edit summary |
|||
| Line 14: | Line 14: | ||
Example requests related to a specific module and statistics can be seen in the web interface by opening the browser development console (Ctrl+Shift+I for Chrome and Firefox, F12 for Edge). | Example requests related to a specific module and statistics can be seen in the web interface by opening the browser development console (Ctrl+Shift+I for Chrome and Firefox, F12 for Edge). | ||
=== | === Credentials === | ||
The credentials are the same as for the web interface. The admin user allows to access all APIs. A non-admin user has read access to most of the statistics. If you have enabled the pcap role, the capture URL is also possible for the API. | The credentials are the same as for the web interface. The admin user allows to access all APIs. A non-admin user has read access to most of the statistics. If you have enabled the pcap role, the capture URL is also possible for the API. | ||
Allegro recommends to set up a separate non-admin user with or without the pcap role for the REST API of only statistics shall be gathered. This will prevent to accidentally shut down or change any configuration by calling the REST API. | Allegro recommends to set up a separate non-admin user with or without the pcap role for the REST API of only statistics shall be gathered. This will prevent to accidentally shut down or change any configuration by calling the REST API. | ||
=== Parallel PCAP Analysis === | |||
In case a parallel PCAP analysis is running, the API call must be given the additional header field "X-AllegroPackets-Multimeter-ID: :1" with the PCAP instance ID. | |||
== Useful shell commands and their parameters == | == Useful shell commands and their parameters == | ||