diff options
| author | Erik Johnston <erik@matrix.org> | 2019-08-22 13:41:57 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2019-08-22 13:41:57 +0100 |
| commit | 1e4b4d85e7f4604d0617bba01b279f3dc2ced1d2 (patch) | |
| tree | 99baa32e4bc755be4c21f5d711b07a86bfff8020 /docs/admin_api/purge_room.md | |
| parent | Make changelog entry be a feature (diff) | |
| parent | Merge pull request #5850 from matrix-org/erikj/retry_well_known_on_fail (diff) | |
| download | synapse-1e4b4d85e7f4604d0617bba01b279f3dc2ced1d2.tar.xz | |
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/reliable_lookups
Diffstat (limited to 'docs/admin_api/purge_room.md')
| -rw-r--r-- | docs/admin_api/purge_room.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/admin_api/purge_room.md b/docs/admin_api/purge_room.md new file mode 100644 index 0000000000..64ea7b6a64 --- /dev/null +++ b/docs/admin_api/purge_room.md @@ -0,0 +1,18 @@ +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. + +The API is: + +``` +POST /_synapse/admin/v1/purge_room + +{ + "room_id": "!room:id" +} +``` + +You must authenticate using the access token of an admin user. |