summary refs log tree commit diff
path: root/docs/admin_api/version_api.rst
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-03-06 19:30:30 +0000
committerErik Johnston <erik@matrix.org>2019-03-06 19:30:30 +0000
commit8f7dbbc14a1e8c7c7bc42afa17bc2f4d88ad3d10 (patch)
tree7f20429e4b25eda5c8dded42a1f0b6ff574b636a /docs/admin_api/version_api.rst
parentReenable presence tests and remove pointless change (diff)
parentMerge pull request #4818 from matrix-org/erikj/prefill_client_ips (diff)
downloadsynapse-8f7dbbc14a1e8c7c7bc42afa17bc2f4d88ad3d10.tar.xz
Merge branch 'develop' of github.com:matrix-org/synapse into matrix-org-hotfixes
Diffstat (limited to 'docs/admin_api/version_api.rst')
-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" + }