summary refs log tree commit diff
path: root/docs/admin_api/purge_room.md
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2021-08-17 22:19:13 +0200
committerGitHub <noreply@github.com>2021-08-17 21:19:13 +0100
commit430241a1e9fd4fbb82d83958b61bbd66c9ba3505 (patch)
tree298aed2bae0d493595b8876a26d3d24c00e94f1f /docs/admin_api/purge_room.md
parentPort the PresenceRouter module interface to the new generic interface (#10524) (diff)
downloadsynapse-430241a1e9fd4fbb82d83958b61bbd66c9ba3505.tar.xz
Remove deprecated Shutdown Room and Purge Room Admin API (#8830)
Diffstat (limited to 'docs/admin_api/purge_room.md')
-rw-r--r--docs/admin_api/purge_room.md21
1 files changed, 0 insertions, 21 deletions
diff --git a/docs/admin_api/purge_room.md b/docs/admin_api/purge_room.md
deleted file mode 100644

index 54fea2db6d..0000000000 --- a/docs/admin_api/purge_room.md +++ /dev/null
@@ -1,21 +0,0 @@ -Deprecated: Purge room API -========================== - -**The old Purge 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.** - -This API will remove all trace of a room from your database. - -All local users must have left the room before it can be removed. - -The API is: - -``` -POST /_synapse/admin/v1/purge_room - -{ - "room_id": "!room:id" -} -``` - -You must authenticate using the access token of an admin user.