Update and rename API.rst to api.rst

dOpensource · Jul 3, 2019 · d3d4628 · d3d4628
1 parent dcb2af1
commit d3d4628
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 19 deletions.
diff --git a/docs/API.rst b/docs/API.rst
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,34 @@
+API
+===
+
+The steps to obtain the API Token key and using the different curl commands are listen below.
+
+Note: Make sure to to ssh into your serve to run these commands.
+
+Getting Your Token
+^^^^^^^^^^^^^^^^^^
+
+::
+
+
+  cat /opt/dsiprouter/gui/settings.py | grep API_TOKEN
+|
+
+Executing Kamailio stats API
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+::
+  
+  curl -H "Authorization: Bearer $DSIP_TOKEN" -X GET http://<addressOfYourInstance>:5000/api/v1/kamailio/stats
+|
+
+Executing Lease Point API
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Getting the endlease
+::
+ curl -H "Authorization: Bearer $DSIP_TOKEN" -H "Content-Type: application/json" -X GET "http://demo.dsiprouter.org:5000/api/v1/endpoint/lease?ttl=15&email=mack@dsiprouter.org"
+ |
+ 
+ Revoking and replacing with your own lease ID
+ ::
+   curl -H "Authorization: Bearer $DSIP_TOKEN" -H "Content-Type: application/json" -X PUT "http://demo.dsiprouter.org:5000/api/v1/endpoint/lease/<leaseid>/revoke"
+|