diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2021-06-03 14:06:03 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-03 14:06:03 +0100 |
| commit | 73636cab69c32746ef6b7708deeeb0c718b7b3b9 (patch) | |
| tree | 9d4354f02e85218e82ea3e4d7fe3acc17869c02b /docs/admin_api/version_api.md | |
| parent | r0.6.1 support: /rooms/:roomId/aliases endpoint (#9224) (diff) | |
| download | synapse-73636cab69c32746ef6b7708deeeb0c718b7b3b9.tar.xz | |
Convert admin api docs to markdown (#10089)
So that they render nicely in mdbook (see #10086), and so that we no longer have a mix of structured text languages in our documentation (excluding files outside of `docs/`).
Diffstat (limited to 'docs/admin_api/version_api.md')
| -rw-r--r-- | docs/admin_api/version_api.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/admin_api/version_api.md b/docs/admin_api/version_api.md new file mode 100644 index 0000000000..efb4a0c0f7 --- /dev/null +++ b/docs/admin_api/version_api.md @@ -0,0 +1,21 @@ +# 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 /_synapse/admin/v1/server_version +``` + +It returns a JSON body like the following: + +```json +{ + "server_version": "0.99.2rc1 (b=develop, abcdef123)", + "python_version": "3.6.8" +} +``` |