summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorJoseph Weston <joseph@weston.cloud>2019-03-02 03:07:04 +0100
committerJoseph Weston <joseph@weston.cloud>2019-03-02 03:07:04 +0100
commit144cbfd6508eb4dceeb13010fb858831bd4d11af (patch)
treea8ab4c94e9a8443ab76d1f719ecd1f8367303b70 /docs/admin_api
parentAdd changelog and AUTHORS file entry (diff)
downloadsynapse-144cbfd6508eb4dceeb13010fb858831bd4d11af.tar.xz
add API documentation
Signed-off-by: Joseph Weston <joseph@weston.cloud>
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/version_api.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/admin_api/version_api.rst b/docs/admin_api/version_api.rst
new file mode 100644
index 0000000000..30a91b5f43
--- /dev/null
+++ b/docs/admin_api/version_api.rst
@@ -0,0 +1,22 @@
+Version API
+===========
+
+This API returns the running Synapse version and the Python version
+on which Synapse is being run. This is useful when a Synapse instance
+is behind a proxy that does not forward the 'Server' header (which also
+contains Synapse version information).
+
+The api is::
+
+    GET /_matrix/client/r0/admin/server_version
+
+including an ``access_token`` of a server admin.
+
+It returns a JSON body like the following:
+
+.. code:: json
+
+    {
+        "server_version": "0.99.2rc1 (b=develop, abcdef123)",
+        "python_version": "3.6.8"
+    }