summary refs log tree commit diff
path: root/UPGRADE.rst
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2020-11-25 22:26:11 +0100
committerGitHub <noreply@github.com>2020-11-25 16:26:11 -0500
commit3f0ff53158cc07b481c701077357d9d09254845b (patch)
treebc1f6f4e6beff92b487e7c45585c4d0a4bfbae4c /UPGRADE.rst
parentFix the formatting of push config section (#8818) (diff)
downloadsynapse-3f0ff53158cc07b481c701077357d9d09254845b.tar.xz
Remove deprecated `/_matrix/client/*/admin` endpoints (#8785)
These are now only available via `/_synapse/admin/v1`.
Diffstat (limited to 'UPGRADE.rst')
-rw-r--r--UPGRADE.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst
index 4de1bb5841..6825b567e9 100644
--- a/UPGRADE.rst
+++ b/UPGRADE.rst
@@ -105,6 +105,28 @@ shown below:
 
           return {"localpart": localpart}
 
+Removal historical Synapse Admin API 
+------------------------------------
+
+Historically, the Synapse Admin API has been accessible under:
+
+* ``/_matrix/client/api/v1/admin``
+* ``/_matrix/client/unstable/admin``
+* ``/_matrix/client/r0/admin``
+* ``/_synapse/admin/v1``
+
+The endpoints with ``/_matrix/client/*`` prefixes have been removed as of v1.24.0.
+The Admin API is now only accessible under:
+
+* ``/_synapse/admin/v1``
+
+The only exception is the `/admin/whois` endpoint, which is
+`also available via the client-server API <https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-admin-whois-userid>`_.
+
+The deprecation of the old endpoints was announced with Synapse 1.20.0 (released
+on 2020-09-22) and makes it easier for homeserver admins to lock down external
+access to the Admin API endpoints.
+
 Upgrading to v1.23.0
 ====================