summary refs log tree commit diff
path: root/docs/administration/admin_api/version_api.md
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2022-10-24 14:05:50 +0100
committerDavid Robertson <davidr@element.io>2022-10-24 14:12:58 +0100
commit032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0 (patch)
tree2e513b6fddf3f8a1b4f285d38d3fd12fa820599b /docs/administration/admin_api/version_api.md
parentMove admin docs to admin section (excluding admin api) (diff)
downloadsynapse-032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0.tar.xz
Rearrange admin API fs heirarchy to match sidebar
I've kept the RST redirect file in-place though
Diffstat (limited to 'docs/administration/admin_api/version_api.md')
-rw-r--r--docs/administration/admin_api/version_api.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/administration/admin_api/version_api.md b/docs/administration/admin_api/version_api.md
new file mode 100644

index 0000000000..27977de0d3 --- /dev/null +++ b/docs/administration/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.7.8" +} +```