anonymousland-synapse/docs/admin_api/purge_room.md

Purge room API
==============

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.

See also: [Delete Room API](rooms.md#delete-room-api)

The API is:

```
POST /_synapse/admin/v1/purge_room

{
    "room_id": "!room:id"
}
```

You must authenticate using the access token of an admin user.
Servlet to purge old rooms (#5845) 2019-08-22 05:42:59 -04:00			`Purge room API`
			`==============`

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

Add delete room admin endpoint (#7613) The Delete Room admin API allows server admins to remove rooms from server and block these rooms. `DELETE /_synapse/admin/v1/rooms/<room_id>` It is a combination and improvement of "[Shutdown room](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/shutdown_room.md)" and "[Purge room](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/purge_room.md)" API. Fixes: #6425 It also fixes a bug in [synapse/storage/data_stores/main/room.py](synapse/storage/data_stores/main/room.py) in ` get_room_with_stats`. It should return `None` if the room is unknown. But it returns an `IndexError`. https://github.com/matrix-org/synapse/blob/901b1fa561e3cc661d78aa96d59802cf2078cb0d/synapse/storage/data_stores/main/room.py#L99-L105 Related to: - #5575 - https://github.com/Awesome-Technologies/synapse-admin/issues/17 Signed-off-by: Dirk Klimpel dirk@klimpel.org 2020-07-14 07:36:23 -04:00			`See also: [Delete Room API](rooms.md#delete-room-api)`

Servlet to purge old rooms (#5845) 2019-08-22 05:42:59 -04:00			`The API is:`

			```
			`POST /_synapse/admin/v1/purge_room`

			`{`
			`"room_id": "!room:id"`
			`}`
			```

			`You must authenticate using the access token of an admin user.`