diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2020-12-10 12:42:48 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-10 11:42:48 +0000 |
| commit | a5f7aff5e5a840c53e79d185d40b22d67dad2ea1 (patch) | |
| tree | 30a0e251dff5edb2ddd9aad1c53e75d2a91f579e /docs/admin_api/shutdown_room.md | |
| parent | Default to blacklisting reserved IP ranges and add a whitelist. (#8870) (diff) | |
| download | synapse-a5f7aff5e5a840c53e79d185d40b22d67dad2ea1.tar.xz | |
Deprecate Shutdown Room and Purge Room Admin API (#8829)
Deprecate both APIs in favour of the Delete Room API. Related: #8663 and #8810
Diffstat (limited to 'docs/admin_api/shutdown_room.md')
| -rw-r--r-- | docs/admin_api/shutdown_room.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/admin_api/shutdown_room.md b/docs/admin_api/shutdown_room.md index 9b1cb1c184..856a629487 100644 --- a/docs/admin_api/shutdown_room.md +++ b/docs/admin_api/shutdown_room.md @@ -1,4 +1,7 @@ -# Shutdown room API +# Deprecated: Shutdown room API + +**The old Shutdown room API is deprecated and will be removed in a future release. +See the new [Delete Room API](rooms.md#delete-room-api) for more details.** Shuts down a room, preventing new joins and moves local users and room aliases automatically to a new room. The new room will be created with the user specified by the @@ -10,8 +13,6 @@ disallow any further invites or joins. The local server will only have the power to move local user and room aliases to the new room. Users on other servers will be unaffected. -See also: [Delete Room API](rooms.md#delete-room-api) - ## API You will need to authenticate with an access token for an admin user. |