diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-08-22 10:42:59 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-22 10:42:59 +0100 |
| commit | 119aa31b105705390e87f87186f787b32e04ba21 (patch) | |
| tree | 6b254acd81c9c11942d556aaa3ec5efd6bdbcdc0 /docs/admin_api/purge_room.md | |
| parent | Improve error msg when key-fetch fails (#5896) (diff) | |
| download | synapse-119aa31b105705390e87f87186f787b32e04ba21.tar.xz | |
Servlet to purge old rooms (#5845)
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. |