From 0a7a1a0ef6ab33d2d2c4f7b98a29505a896ec1ba Mon Sep 17 00:00:00 2001
From: laf <neil@lathwood.co.uk>
Date: Sun, 30 Nov 2014 17:11:08 +0000
Subject: [PATCH] Added docs for the route

---
 html/pages/api-docs.inc.php | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/html/pages/api-docs.inc.php b/html/pages/api-docs.inc.php
index bddb64729..02d9330b8 100644
--- a/html/pages/api-docs.inc.php
+++ b/html/pages/api-docs.inc.php
@@ -296,6 +296,29 @@ if ($_SESSION['userlevel'] == '10')
         <tr>
           <td colspan="5"><code>curl -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/bgp"</code></td>
         </tr>
+        <tr class="success">
+          <td colspan="5"><strong>List ports for a device</strong></td>
+        </tr>
+        <tr>
+          <td>/api</td>
+          <td>/v0</td>
+          <td>/devices/$hostname/ports</td>
+          <td>
+            <ul class="list-unstyled">
+              <li>hostname = the hostname to list vlans for</li>
+              <li>columns = the columns to return in the response</li>
+            </ul>
+          </td>
+          <td>
+            JSON
+          </td>
+        </tr>
+        <tr>
+          <td colspan="5"><code>curl -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/devices/localhost/ports"</code></td>
+        </tr>
+        <tr>
+          <td colspan="5"><code>curl -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/devices/localhost/ports?columns=ifDescr,ifName"</code></td>
+        </tr>
       </table>
     </div>
   </div>