MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-11-16 06:51:46 +01:00
Code Issues Projects Releases Wiki Activity
synapse/docs/admin_api/purge_room.md
Dirk Klimpel a5f7aff5e5
Deprecate Shutdown Room and Purge Room Admin API (#8829) 
Deprecate both APIs in favour of the Delete Room API.

Related: #8663 and #8810
2020-12-10 11:42:48 +00:00

492 B
Raw Blame History

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 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.