REST API description: Difference between revisions

REST API description (view source)

774 bytes added , 11 May 2020

404

edits

@@ Line 81: / Line 81: @@
 <pre>
-$ curl --silent -k -u 'admin:allegro'  'https://allegro-mm-XXXX/API/stats' -X OPTIONS
+$ curl --silent -k -u 'admin:allegro'  'https://allegro-mm/API/stats' -X OPTIONS
 {
    "subResources": [
@@ Line 102: / Line 102: @@
 <pre>
-$ curl --silent -k -u 'admin:allegro'  'https://allegro-mm-XXXX/API/stats/modules' -X OPTIONS
+$ curl --silent -k -u 'admin:allegro'  'https://allegro-mm/API/stats/modules' -X OPTIONS
 {
    "subResources": [
@@ Line 140: / Line 140: @@
      "mac",
      "capture"
+  ]
+}
+</pre>
+=== Additional Paths with ===
+Some modules allow to use a parameter as part of the URI like the IP or Mac address. The path <code>API/stats/modules/ip/ips</code> allows you to use an IP address as next uri element
+<pre>
+$ curl --silent -k -u 'admin:allegro'  'https://allegro-mm/API/stats/modules/ip/ips' -X OPTIONS
+{
+  "subResources": [
+    "protocol",
+    ":ip"
+  ]
+}
+</pre>
+The path of an IP address shows all further available elements:
+<pre>
+$ curl --silent -k -u 'admin:allegro'  'https://allegro-mm/API/stats/modules/ip/ips/10.0.54.254' -X OPTIONS
+{
+  "subResources": [
+    "sip_request_responses",
+    "peers_ports",
+    "sip_responses",
+    "sip_requests",
+    "qos",
+    "ports",
+    "connections",
+    "protocols",
+    "macs",
+    "peers",
+    "tcpStats"
    ]
 }