diff options
| author | Erik Johnston <erikj@jki.re> | 2019-03-05 16:31:00 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-05 16:31:00 +0000 |
| commit | 16c8b4ecbd99c4be6419bf65212acc613a179950 (patch) | |
| tree | 40d5d962898b33a964b6d3f4e834d8ad98a8d05e /docs/admin_api/version_api.rst | |
| parent | Add rate-limiting on registration (#4735) (diff) | |
| parent | add API documentation (diff) | |
| download | synapse-16c8b4ecbd99c4be6419bf65212acc613a179950.tar.xz | |
Merge pull request #4772 from jbweston/jbweston/server-version-api
Add 'server_version' endpoint to admin API
Diffstat (limited to 'docs/admin_api/version_api.rst')
| -rw-r--r-- | docs/admin_api/version_api.rst | 22 |
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" + } |