summaryrefslogtreecommitdiffstats
path: root/docs/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 00000000..29dd5ade
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,15 @@
+.. _api:
+
+API Documentation
+=================
+
+Glances provides an `XML-RPC server`_ and a `RESTful-JSON`_ API which
+can be used by other clients.
+
+API documentation is available at:
+
+- XML-RPC: https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to
+- RESTful-JSON: https://github.com/nicolargo/glances/wiki/The-Glances-RESTFULL-JSON-API
+
+.. _XML-RPC server: http://docs.python.org/2/library/simplexmlrpcserver.html
+.. _RESTful-JSON: http://jsonapi.org/