diff options
| author | Andrew Morgan <andrew@amorgan.xyz> | 2020-02-21 11:01:08 +0000 |
|---|---|---|
| committer | Andrew Morgan <andrew@amorgan.xyz> | 2020-02-21 11:01:08 +0000 |
| commit | 5a60e070fe676f522650f29da65113fc6e054ec0 (patch) | |
| tree | 66c6acf1c95936c75510f18133f235d01b6dbefa /docs | |
| parent | Improve error msg when key-fetch fails (#5896) (diff) | |
| parent | Servlet to purge old rooms (#5845) (diff) | |
| download | synapse-5a60e070fe676f522650f29da65113fc6e054ec0.tar.xz | |
Servlet to purge old rooms (#5845)
Diffstat (limited to 'docs')
| -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. |